
## Get Started
### Installation
Follow [these instructions](https://react-native-training.github.io/react-native-elements/docs/getting_started.html) to install React Native Elements !
### Usage
Start using the components or try it on Snack [here](https://snack.expo.io/rJu6gJfBZ).
```js
import { Button } from 'react-native-elements';
;
```
## Components included:
* [x] [Avatar](https://react-native-training.github.io/react-native-elements/docs/0.19.0/avatar.html)
* [x] [Badge](https://react-native-training.github.io/react-native-elements/docs/0.19.0/badge.html)
* [x] [Button](https://react-native-training.github.io/react-native-elements/docs/0.19.0/button.html)
* [x] [ButtonGroup](https://react-native-training.github.io/react-native-elements/docs/0.19.0/button_group.html)
* [x] [Card](https://react-native-training.github.io/react-native-elements/docs/0.19.0/card.html)
* [x] [Checkbox](https://react-native-training.github.io/react-native-elements/docs/0.19.0/checkbox.html)
* [x] [Form Elements](https://react-native-training.github.io/react-native-elements/docs/0.19.0/forms.html)
* [x] [HTML style headings](https://react-native-training.github.io/react-native-elements/docs/0.19.0/text.html)
* [x] [Icon](https://react-native-training.github.io/react-native-elements/docs/0.19.0/icon.html)
* [x] [List and ListItem](https://react-native-training.github.io/react-native-elements/docs/0.19.0/lists.html)
* [x] [Pricing](https://react-native-training.github.io/react-native-elements/docs/0.19.0/pricing.html)
* [x] [Rating](https://react-native-training.github.io/react-native-elements/docs/0.19.0/rating.html)
* [x] [Search Bar](https://react-native-training.github.io/react-native-elements/docs/0.19.0/searchbar.html)
* [x] [Slider](https://react-native-training.github.io/react-native-elements/docs/0.19.0/slider.html)
* [x] [Social Icons / Social Icon Buttons](https://react-native-training.github.io/react-native-elements/docs/0.19.0/social_icon.html)
* [x] [Tile](https://react-native-training.github.io/react-native-elements/docs/0.19.0/tile.html)
## RNE Ecosystem:
React Native Elements also serves as a **platform** that connects **small teams/individuals** that needs help developing their RN app with **open source contributors** that are willing to **build complex UI screens & animated interactions** for 💰💰💰.
Here are some of the screens that our developers have created so far:
If this sounds interesting and you would like to participate, kindly open a **new issue with the design & spec of the UI screen** that you need to be developed. One of our developers will respond to your issue with an estimate of time & cost.
It's built on top of **RNE & Open Collective**. If you have any feedback or would like to know more details about this kindly contact **[Monte Thakkar](https://github.com/Monte9)**.
## Expo Demo App
Checkout the official [React Native Elements App](https://expo.io/@monte9/react-native-elements-app) on Expo which uses all of the React Native Elements components.
If you are looking to contribute to the React Native Elements App, click [here](https://github.com/react-native-training/react-native-elements-app) to view the implementation & run the RNE expo app locally.
## v1.0 Roadmap 🏃 🏎 🏇
Current release: `1.0.0-beta5`
### New Features:
* [x] Button component **(re-write)** - @monte9
* [x] Input component **(re-write)** - @monte9 & @xavier-villelegier
* [x] Search component - **Platform specific (re-write)** - @xavier-villelegier
* [x] Avatar component **(refactored)** - @monte9
* [x] Production-ready screens 🔥 💯 🎸 - @monte9, @xavier-villelegier, @martinezguillaume
* [x] **Launching RNE Ecosystem** ✨🚀✨ - @monte9
* [ ] ListItem component - **Platform specific (re-write)** - @martinezguillaume, @johot **WIP**
* [ ] Themes support - **NEW** - @iRoachie **WIP**
* [ ] React Native Web support - **NEW** - @Gregor1971 **WIP** - [branch](https://github.com/react-native-training/react-native-elements/tree/rn-web) - [PR](https://github.com/react-native-training/react-native-elements/pull/867)
### v1.0 TODO:
* [x] Update docs for Button component
* [x] Update docs for Input component
* [x] Update docs for Search component
* [x] Write detailed release notes with new features & breaking changes
* [x] Update react, react-native & other dependencies
* [ ] Update docs for ListItem component **(Pending rewrite of component)** - **[$20](https://opencollective.com/react-native-elements#budget)**
* [ ] Write docs for Themes support **(Pending completion of theme support)** - **[$20](https://opencollective.com/react-native-elements#budget)**
* [ ] Create a compelling demo/example app for RNE + RNW (Checkout [rn-web](https://github.com/react-native-training/react-native-elements/tree/rn-web) branch or [this PR comment](https://github.com/react-native-training/react-native-elements/pull/867#issuecomment-362312699) for context) - **[$50](https://opencollective.com/react-native-elements#budget)**
* [ ] Write docs for React Native Web support (Checkout [rn-web](https://github.com/react-native-training/react-native-elements/tree/rn-web) branch or [this PR comment](https://github.com/react-native-training/react-native-elements/pull/867#issuecomment-362312699) for context) - **[$50](https://opencollective.com/react-native-elements#budget)**
* [ ] Recreate Settings page on iOS & android (to show listItem + searchBar + themes components) - **WIP** - @martinezguillaume
Feel free to reach out to us on our [Slack channel](https://reactnativetraining.herokuapp.com) if you have any questions about what to work on.
### Release plan:
Since this is a beta release, any new installation of react-native-elements will get `v0.19.0`. If you would like to try out our `v1.0.0` beta releases (we highly suggest you do), run the following command:
`yarn add react-native-elements@beta`
Since `v1` has a lot of API changes (many of which are breaking changes due to re-written components), the `v1.0.0` beta releases are meant to give our users a heads up and give them plenty of time to migrate their apps to `v1`.
The official `v1.0.0` will be released around mid-March 2018 🎉
### Test v1.0 components
You can test new features of the `v1.0.0` beta releases on [Expo Snack](https://snack.expo.io/) by modifying the `package.json` file:
`"react-native-elements": "^1.0.0-beta"`
This will install the latest beta release of React Native Elements.
## Documentation
[View the full docs here](https://react-native-training.github.io/react-native-elements/docs/0.19.0/overview.html)
## Contributing
Interested in contributing to this repo? Check out our [Contributing Guide](https://react-native-training.github.io/react-native-elements/docs/contributing.html) and submit a PR for a new feature/bug fix.
### First Contributors
We encourage everyone to contribute & submit PR's especially first-time contributors. Look for the label `good first issue` on the issues. Click [here](https://github.com/react-native-training/react-native-elements/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to see them.
If there is something you's like to see or request a new feature, please submit an [issue](https://github.com/react-native-training/react-native-elements/issues/new) or a [pull request](https://github.com/react-native-training/react-native-elements/pulls).
### Slack Community
In case you have any other question or would like to come say **Hi!** to the RNE community, join our [Slack team](https://reactnativetraining.herokuapp.com/). See you on the other side! 👋😃
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/react-native-elements#backer)]
## Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/react-native-elements#sponsor)]