| 1 | <p align="center">
|
| 2 | <a href="https://reactnativeelements.com/">
|
| 3 | <img alt="react-native-elements" src="https://user-images.githubusercontent.com/5962998/65694309-a825f000-e043-11e9-8382-db0dba0851e3.png" width="300">
|
| 4 | </a>
|
| 5 | </p>
|
| 6 |
|
| 7 | <p align="center">
|
| 8 | Cross Platform <a href="https://reactnative.dev">React Native</a> UI Toolkit
|
| 9 | </p>
|
| 10 |
|
| 11 | <p align="center">
|
| 12 | <a href="https://www.npmjs.com/package/react-native-elements"><img src="https://img.shields.io/npm/v/react-native-elements.svg"></a>
|
| 13 | <a href="https://travis-ci.org/react-native-elements/react-native-elements"><img src="https://img.shields.io/travis/react-native-elements/react-native-elements/master.svg"></a>
|
| 14 | <a href="https://github.com/react-native-elements/react-native-elements"><img src="https://img.shields.io/github/stars/react-native-elements/react-native-elements"></a>
|
| 15 | <a href="https://www.npmjs.com/package/react-native-elements"><img src="https://img.shields.io/npm/dm/react-native-elements.svg"></a>
|
| 16 | <a href="https://react-native-elements-slack.herokuapp.com"><img src="https://react-native-elements-slack.herokuapp.com/badge.svg"></a>
|
| 17 | </p>
|
| 18 |
|
| 19 | <p align="center">
|
| 20 | <a href="#backers"><img src="https://opencollective.com/react-native-elements/backers/badge.svg"></a>
|
| 21 | <a href="#sponsors"><img src="https://opencollective.com/react-native-elements/sponsors/badge.svg"></a>
|
| 22 | <a href="https://codecov.io/gh/react-native-elements/react-native-elements"><img src="https://codecov.io/gh/react-native-elements/react-native-elements/coverage.svg"></a>
|
| 23 | <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg"></a>
|
| 24 | <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
|
| 25 |
|
| 26 | </p>
|
| 27 |
|
| 28 | <br />
|
| 29 |
|
| 30 | 
|
| 31 |
|
| 32 | ## Get Started
|
| 33 |
|
| 34 | ### Installation
|
| 35 |
|
| 36 | Follow
|
| 37 | [these instructions](https://reactnativeelements.com/docs/)
|
| 38 | to install React Native Elements!
|
| 39 |
|
| 40 | ### Usage
|
| 41 |
|
| 42 | Start using the components or try it on Snack
|
| 43 | [here](https://snack.expo.io/rJu6gJfBZ).
|
| 44 |
|
| 45 | ```js
|
| 46 | import { Button } from 'react-native-elements';
|
| 47 |
|
| 48 | <Button />;
|
| 49 | ```
|
| 50 |
|
| 51 | ## Components included:
|
| 52 |
|
| 53 | - [x] [Avatar](https://reactnativeelements.com/docs/avatar)
|
| 54 | - [x] [Badge](https://reactnativeelements.com/docs/badge)
|
| 55 | - [x] [BottomSheet](https://reactnativeelements.com/docs/bottomsheet)
|
| 56 | - [x] [Button](https://reactnativeelements.com/docs/button)
|
| 57 | - [x] [ButtonGroup](https://reactnativeelements.com/docs/button_group)
|
| 58 | - [x] [Card](https://reactnativeelements.com/docs/card)
|
| 59 | - [x] [CheckBox](https://reactnativeelements.com/docs/checkbox)
|
| 60 | - [x] [Divider](https://reactnativeelements.com/docs/divider)
|
| 61 | - [x] [Header](https://reactnativeelements.com/docs/header)
|
| 62 | - [x] [HTML style headings](https://reactnativeelements.com/docs/text)
|
| 63 | - [x] [Icon](https://reactnativeelements.com/docs/icon)
|
| 64 | - [x] [Image](https://reactnativeelements.com/docs/image)
|
| 65 | - [x] [Input](https://reactnativeelements.com/docs/input)
|
| 66 | - [x] [ListItem](https://reactnativeelements.com/docs/listitem)
|
| 67 | - [x] [Overlay](https://reactnativeelements.com/docs/overlay)
|
| 68 | - [x] [Pricing](https://reactnativeelements.com/docs/pricing)
|
| 69 | - [x] [Rating](https://reactnativeelements.com/docs/rating)
|
| 70 | - [x] [SearchBar](https://reactnativeelements.com/docs/searchbar)
|
| 71 | - [x] [Slider](https://reactnativeelements.com/docs/slider)
|
| 72 | - [x] [Social Icons / Social Icon Buttons](https://reactnativeelements.com/docs/social_icon)
|
| 73 | - [x] [Tile](https://reactnativeelements.com/docs/tile)
|
| 74 | - [x] [Tooltip](https://reactnativeelements.com/docs/tooltip)
|
| 75 |
|
| 76 | ## React Native Web support
|
| 77 |
|
| 78 | As a cross platform UI Toolkit, you can now use RNE on the web & share your codebase between your React Native + React web apps. RNE components are rendered perfectly on browser. You can achieve this to target iOS, Android and Web by collaborating RNE and [React Native for Web](https://github.com/necolas/react-native-web).
|
| 79 |
|
| 80 | Click [here](https://reactnativeelements.com/blog/2018/12/13/react-native-web) for a full walkthrough using React Native Elements + React Native Web.
|
| 81 |
|
| 82 | ## Demo App
|
| 83 |
|
| 84 | Checkout the official
|
| 85 | [React Native Elements App](https://expo.io/@monte9/react-native-elements-app)
|
| 86 | on Expo which uses all of the React Native Elements components.
|
| 87 |
|
| 88 | If you are looking to contribute to the React Native Elements App, click
|
| 89 | [here](https://github.com/react-native-elements/react-native-elements-app) to
|
| 90 | view the implementation & run the RNE expo app locally.
|
| 91 |
|
| 92 | ## Documentation
|
| 93 |
|
| 94 | [View the full docs here](https://reactnativeelements.com/docs/overview)
|
| 95 |
|
| 96 | ## Contributing
|
| 97 |
|
| 98 | Interested in contributing to this repo? Check out our
|
| 99 | [Contributing Guide](https://reactnativeelements.com/docs/contributing)
|
| 100 | and submit a PR for a new feature/bug fix.
|
| 101 |
|
| 102 | A big shoutout to all our contributors! You could be here too!
|
| 103 |
|
| 104 | <a href="https://github.com/react-native-elements/react-native-elements/graphs/contributors"><img src="https://opencollective.com/react-native-elements/contributors.svg?width=890&button=false" /></a>
|
| 105 |
|
| 106 | ### First Contributors
|
| 107 |
|
| 108 | We encourage everyone to contribute & submit PR's especially first-time
|
| 109 | contributors. Look for the label `Good First Issue` on the issues. Click
|
| 110 | [here](https://github.com/react-native-elements/react-native-elements/labels/%F0%9F%91%B6%20Good%20First%20Issue)
|
| 111 | to see them.
|
| 112 |
|
| 113 | If there is something you's like to see or request a new feature, please submit
|
| 114 | an
|
| 115 | [issue](https://github.com/react-native-elements/react-native-elements/issues/new)
|
| 116 | or a
|
| 117 | [pull request](https://github.com/react-native-elements/react-native-elements/pulls).
|
| 118 |
|
| 119 | ### Core Contributors
|
| 120 |
|
| 121 | We are currently looking for new core contributors that can help lead this project.
|
| 122 |
|
| 123 | [Learn more here](https://github.com/react-native-elements/react-native-elements/issues/2222)
|
| 124 |
|
| 125 | ### Slack Community
|
| 126 |
|
| 127 | In case you have any other question or would like to come say **Hi!** to the RNE
|
| 128 | community, join our [Slack team](https://react-native-elements-slack.herokuapp.com).
|
| 129 | See you on the other side! 👋😃
|
| 130 |
|
| 131 | ## Backers
|
| 132 |
|
| 133 | [Become a backer](https://opencollective.com/react-native-elements#backer) and show your support for React Native Elements.
|
| 134 |
|
| 135 | [](https://opencollective.com/react-native-elements/backer/0/website)
|
| 136 | [](https://opencollective.com/react-native-elements/backer/1/website)
|
| 137 | [](https://opencollective.com/react-native-elements/backer/2/website)
|
| 138 | [](https://opencollective.com/react-native-elements/backer/3/website)
|
| 139 | [](https://opencollective.com/react-native-elements/backer/4/website)
|
| 140 | [](https://opencollective.com/react-native-elements/backer/5/website)
|
| 141 | [](https://opencollective.com/react-native-elements/backer/6/website)
|
| 142 | [](https://opencollective.com/react-native-elements/backer/7/website)
|
| 143 | [](https://opencollective.com/react-native-elements/backer/8/website)
|
| 144 | [](https://opencollective.com/react-native-elements/backer/9/website)
|
| 145 | [](https://opencollective.com/react-native-elements/backer/10/website)
|
| 146 | [](https://opencollective.com/react-native-elements/backer/11/website)
|
| 147 | [](https://opencollective.com/react-native-elements/backer/12/website)
|
| 148 | [](https://opencollective.com/react-native-elements/backer/13/website)
|
| 149 | [](https://opencollective.com/react-native-elements/backer/14/website)
|
| 150 | [](https://opencollective.com/react-native-elements/backer/15/website)
|
| 151 | [](https://opencollective.com/react-native-elements/backer/16/website)
|
| 152 | [](https://opencollective.com/react-native-elements/backer/17/website)
|
| 153 | [](https://opencollective.com/react-native-elements/backer/18/website)
|
| 154 | [](https://opencollective.com/react-native-elements/backer/19/website)
|
| 155 | [](https://opencollective.com/react-native-elements/backer/20/website)
|
| 156 | [](https://opencollective.com/react-native-elements/backer/21/website)
|
| 157 | [](https://opencollective.com/react-native-elements/backer/22/website)
|
| 158 | [](https://opencollective.com/react-native-elements/backer/23/website)
|
| 159 | [](https://opencollective.com/react-native-elements/backer/24/website)
|
| 160 | [](https://opencollective.com/react-native-elements/backer/25/website)
|
| 161 | [](https://opencollective.com/react-native-elements/backer/26/website)
|
| 162 | [](https://opencollective.com/react-native-elements/backer/27/website)
|
| 163 | [](https://opencollective.com/react-native-elements/backer/28/website)
|
| 164 | [](https://opencollective.com/react-native-elements/backer/29/website)
|
| 165 |
|
| 166 | ## Sponsors
|
| 167 |
|
| 168 | Do you use React Native Elements in production? If so, consider supporting this project as it will allow the maintainers to dedicate more time to maintaining this project and also building new features for everyone. Also, your app or company's logo will show [on GitHub](https://github.com/react-native-elements/react-native-elements#sponsors) and link to your website - who doesn't want a little extra exposure? [Here's the info](https://opencollective.com/react-native-elements#sponsor).
|
| 169 |
|
| 170 | [](https://opencollective.com/react-native-elements/sponsor/0/website)
|
| 171 | [](https://opencollective.com/react-native-elements/sponsor/1/website)
|
| 172 | [](https://opencollective.com/react-native-elements/sponsor/2/website)
|
| 173 | [](https://opencollective.com/react-native-elements/sponsor/3/website)
|
| 174 | [](https://opencollective.com/react-native-elements/sponsor/4/website)
|
| 175 | [](https://opencollective.com/react-native-elements/sponsor/5/website)
|
| 176 | [](https://opencollective.com/react-native-elements/sponsor/6/website)
|
| 177 | [](https://opencollective.com/react-native-elements/sponsor/7/website)
|
| 178 | [](https://opencollective.com/react-native-elements/sponsor/8/website)
|
| 179 | [](https://opencollective.com/react-native-elements/sponsor/9/website)
|
| 180 | [](https://opencollective.com/react-native-elements/sponsor/10/website)
|
| 181 | [](https://opencollective.com/react-native-elements/sponsor/11/website)
|
| 182 | [](https://opencollective.com/react-native-elements/sponsor/12/website)
|
| 183 | [](https://opencollective.com/react-native-elements/sponsor/13/website)
|
| 184 | [](https://opencollective.com/react-native-elements/sponsor/14/website)
|
| 185 | [](https://opencollective.com/react-native-elements/sponsor/15/website)
|
| 186 | [](https://opencollective.com/react-native-elements/sponsor/16/website)
|
| 187 | [](https://opencollective.com/react-native-elements/sponsor/17/website)
|
| 188 | [](https://opencollective.com/react-native-elements/sponsor/18/website)
|
| 189 | [](https://opencollective.com/react-native-elements/sponsor/19/website)
|