Skip to content

Latest commit

 

History

History
166 lines (111 loc) · 8.42 KB

README.md

File metadata and controls

166 lines (111 loc) · 8.42 KB

Nativebase Logo NativeBase 3.0 Financial Contributors on Open Collective Build Status npm version npm downloads

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.

Table of Content

  1. What is NativeBase 3.0?
  2. Why NativeBase 3.0?
  3. KitchenSink App
  4. Compairing available options
  5. Inspirations
  6. API
  7. Getting Started
  8. Components
  9. Documentation
  10. Website
  11. Quick Links to NativeBase
  12. About the creators

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 Popularity
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 get NativeBase running onto your native apps, install it using npm or yarn. 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 react-native-svg styled-components styled-system react-native-safe-area-context
# using npm
npm install native-base@next react-native-svg styled-components styled-system react-native-safe-area-context

Run pod install

cd ios/
pod install

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 to create universal (iOS, Android and Web) React Native apps with no build configuration.

Install NativeBase

# using yarn
yarn add native-base@next styled-components styled-system
expo install react-native-svg
expo install react-native-safe-area-context
# using npm
npm install native-base@next styled-components styled-system
expo install react-native-svg
expo install react-native-safe-area-context

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 explore more.

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.

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]