react-native-zero-ui/docs/index.md

Zero Molecule UI kit for React Native

## Get Started

### Installation

- If you want just the components, you need to add the plugin using 

  ```bash
  npm install react-native-zero-ui --save
  ```

   or 

  ```bash
  yarn add react-native-zero-ui
  ```

  ​

- If you require to use full potential of the plugin, you need to add [@shoutem/theme](https://github.com/shoutem/theme) plugin as well. You can do it by typing 

  ```bash
  npm install @shoutem/theme --save
  ```

  or

  ```bash
  yarn add @shoutem/theme
  ```

  ​

### Usage

Start using the components or try it on Snack [here](https://snack.expo.io/rJu6gJfBZ).

```js
import { Button } from 'react-native-elements';

<Button
  raised
  icon={{name: 'home', size: 32}}
  buttonStyle={{backgroundColor: 'red', borderRadius: 10}}
  textStyle={{textAlign: 'center'}}
  title={`Welcome to\nReact Native Elements`}
/>
```

## Components Included

- [x] [Button](https://zeromolecule.github.io/react-native-zero-ui/button)
- [x] [Text](https://zeromolecule.github.io/react-native-zero-ui/text)
- [x] [View](https://zeromolecule.github.io/react-native-zero-ui/view)
- [x] [TextInput](https://zeromolecule.github.io/react-native-zero-ui/textInput)
- [ ] [ScrollView](https://zeromolecule.github.io/react-native-zero-ui/scrollView)
- [ ] [Image](https://zeromolecule.github.io/react-native-zero-ui/image)
- [ ] [Checkbox](https://zeromolecule.github.io/react-native-zero-ui/checkbox)
- [ ] [Icon](https://zeromolecule.github.io/react-native-zero-ui/icon)
- [ ] [Rating](https://zeromolecule.github.io/react-native-zero-ui/rating)
- [ ] [Slider](https://zeromolecule.github.io/react-native-zero-ui/slider)

## Documentation

[View the full docs here](https://zeromolecule.github.io/react-native-zero-ui)

## Demo App

<!--Checkout the official [Zero UI App](https://expo.io/@dmacan/react-native-zero-ui-app) on Expo which uses all of the React Native Zero UI components.--> 

Additionally, take a look at the [example/](https://github.com/ZeroMolecule/react-native-zero-ui/tree/master/example) folder to view the implementation & run the RNE expo app locally.