README

NativeBase 3.0

A complete component library for React Native Ecosystem

Accessible : Maximise app usage with our accessible design.
Responsive : Create responsive apps with ease from the get-go.
Themeable : Customise your app theme and component styles.
Consistent : Make accurate predictions for web, Android & iOS.

Documentation

You can find the complete documentation here.

1. What is NativeBase 3.0?

NativeBase is a universal Design System for Mobile & Web built for React Native and React with the same API. Ships a bunch of components for most of the use-cases that includes Button, AppBar, Dialog, Modal and what not.

2. Why NativeBase 3.0?

We want to build and ship apps fast with the highest quality. We want to focus on the business logic and to solve real problems.

4. Compairing the available options

Name	Web	Mobile	Design System	Customizable	Components	Language	Docs
Ant Design	Yes	Partial	Yes	Low	Many	JavaScript	Very good
Braid Design System	Yes	No	Yes	Medium	Many	JavaScript	Good
Bootstrap	Yes	No	Yes	Medium	Limited	CSS	Very good
TailwindCSS	Yes	Partial	Yes	High	Rich (with TailwindUI)	CSS	Very good
Flutter Material	Yes	Yes	Yes	High	Many	Dart	Average
NativeBase 3.0	Yes	Yes	Yes	High	Rich	JavaScript	Very good

5. Inspirations

Ant Design, Braid Design System, Bootstrap, TailwindCSS, Flutter Material

6. API

Declarative and Imperative. Declarative for components and Imperative for all the actions

7. Getting Started

To have NativeBase components running onto your native apps, all you need to do is, create a fresh React Native project using whatever you want, expo is a really great starting point so we will start with that and install the NativeBase using npm or yarn and add all the peer dependencies.

Setup with React Native

react-native init AwesomeNativeBase
cd AwesomeNativeBase

Install NativeBase

# using yarn
yarn add native-base@next

# using npm
npm i native-base@next

Install Peer Dependencies

The peer dependencies included from any npm packages does not automatically get installed. Your application will not depend on it explicitly.

react-native link

You've successfully setup NativeBase with your React Native app. Your React Native app is ready to run on iOS and Android devices.

Setup with Expo

Expo helps you make React Native apps with no build configuration. It works on macOS, Windows, and Linux. Refer this link for additional information on Expo and setting up an Expo starter app.

Install NativeBase

# using yarn
yarn add native-base@next

# using npm
npm i native-base@next

We will also have to install these peer dependencies

Install react-native-svg

# using yarn
yarn add react-native-svg

# using npm
npm i react-native-svg

Install react-native-vector-icons

# using yarn
yarn add react-native-vector-icons

# using npm
npm i react-native-vector-icons

Install styled-components

# using yarn
yarn add styled-components

# using npm
npm i styled-components

Install styled-system

# using yarn
yarn add styled-system

# using npm
npm i styled-system

8. Components

NativeBase 3.0 is made from two types of components — Primitives and Composite.

Primitive components are the building blocks.
Composite components are made up of primitive components.

9. Documentation

Go through NativeBase Docs to play with NativeBase.

10. Website

https://nativebase.github.io/

11. Quick Links to NativeBase

12. About the creators

We are GeekyAnts, a startup based in Bangalore, India with 200+ developers in strength. We have been very active in the React / React Native community where we have developed StrapUI and StartReact. Our other products include StartLaravel and StartAngular.

Another major project by us is BuilderX, a screen design tool which codes React Native for you.