UNPKG

10.9 kBMarkdownView Raw
1<p align="center">
2 <img alt="react-native-paper" src="docs/assets/images/paper-logo.svg?sanitize=true" width="300">
3</p>
4<p align="center">
5 Material design for React Native.<br/>
6 <a href="https://reactnativepaper.com">reactnativepaper.com</a>
7</p>
8
9---
10
11[![Greenkeeper badge](https://badges.greenkeeper.io/callstack/react-native-paper.svg)](https://greenkeeper.io/)
12
13[![Build Status][build-badge]][build]
14[![Version][version-badge]][package]
15[![MIT License][license-badge]][license]
16[![All Contributors][all-contributors-badge]][all-contributors]
17[![PRs Welcome][prs-welcome-badge]][prs-welcome]
18[![Chat][chat-badge]][chat]
19[![Sponsored by Callstack][callstack-badge]][callstack]
20
21## Features
22
23- Follows [material design guidelines](https://material.io/guidelines/)
24- Works on both iOS and Android following [platform adaptation guidelines](https://material.io/design/platform-guidance/cross-platform-adaptation.html)
25- Full [theming support](https://callstack.github.io/react-native-paper/theming.html)
26
27Currently supported React Native version: `>= 0.50.3`
28
29## Try it out
30
31Run the [example app](https://snack.expo.dev/@react-native-paper/github.com-callstack-react-native-paper:example) with [Expo](https://expo.dev/) to see it in action.
32
33The source code for the examples are under the [/example](/example) folder.
34
35## Getting Started
36
37Refer to the [getting started guide](https://callstack.github.io/react-native-paper/getting-started.html) for instructions.
38
39## Documentation
40
41Check the components and their usage in our [documentation](https://callstack.github.io/react-native-paper/index.html).
42
43## Contributing
44
45Read the [contribution guidelines](/CONTRIBUTING.md) before contributing.
46
47## Figma and Sketch component kits
48
49Use official component kits provided by [Material Design](https://material.io/resources).
50
51## Made with โค๏ธ at Callstack
52
53`react-native-paper` is an open source project and will always remain free to use. If you think it's cool, please star it ๐ŸŒŸ. [Callstack][callstack-readme-with-love] is a group of React and React Native geeks, contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these or just want to say hi!
54
55Like the project? โš›๏ธ [Join the team](https://callstack.com/careers/?utm_campaign=Senior_RN&utm_source=github&utm_medium=readme) who does amazing stuff for clients and drives React Native Open Source! ๐Ÿ”ฅ
56
57<!-- badges -->
58
59[build-badge]: https://img.shields.io/circleci/project/github/callstack/react-native-paper/main.svg?style=flat-square
60[build]: https://circleci.com/gh/callstack/react-native-paper
61[version-badge]: https://img.shields.io/npm/v/react-native-paper.svg?style=flat-square
62[package]: https://www.npmjs.com/package/react-native-paper
63[license-badge]: https://img.shields.io/npm/l/react-native-paper.svg?style=flat-square
64[license]: https://opensource.org/licenses/MIT
65[all-contributors-badge]: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
66[all-contributors]: #contributors
67[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
68[prs-welcome]: http://makeapullrequest.com
69[chat-badge]: https://img.shields.io/discord/426714625279524876.svg?style=flat-square&colorB=758ED3
70[chat]: https://discord.gg/zwR2Cdh
71[callstack-badge]: https://callstack.com/images/callstack-badge.svg
72[callstack]: https://callstack.com/open-source/?utm_source=github.com&utm_medium=referral&utm_campaign=react-native-paper&utm_term=readme-badge
73[callstack-readme-with-love]: https://callstack.com/?utm_source=github.com&utm_medium=referral&utm_campaign=react-native-paper&utm_term=readme-with-love
74
75## Contributors
76
77Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
78
79<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
80<!-- prettier-ignore -->
81<table>
82 <tr>
83 <td align="center"><a href="https://twitter.com/@satya164"><img src="https://avatars2.githubusercontent.com/u/1174278?v=4" width="100px;" alt="Satyajit Sahoo"/><br /><sub><b>Satyajit Sahoo</b></sub></a><br /><a href="#ideas-satya164" title="Ideas, Planning, & Feedback">๐Ÿค”</a> <a href="https://github.com/callstack/react-native-paper/commits?author=satya164" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=satya164" title="Documentation">๐Ÿ“–</a></td>
84 <td align="center"><a href="https://ferrannp.com/"><img src="https://avatars2.githubusercontent.com/u/774577?v=4" width="100px;" alt="Ferran Negre"/><br /><sub><b>Ferran Negre</b></sub></a><br /><a href="#ideas-ferrannp" title="Ideas, Planning, & Feedback">๐Ÿค”</a> <a href="https://github.com/callstack/react-native-paper/commits?author=ferrannp" title="Code">๐Ÿ’ป</a></td>
85 <td align="center"><a href="http://dawidurbaniak.pl"><img src="https://avatars3.githubusercontent.com/u/18584155?v=4" width="100px;" alt="Dawid"/><br /><sub><b>Dawid</b></sub></a><br /><a href="#ideas-Trancever" title="Ideas, Planning, & Feedback">๐Ÿค”</a> <a href="https://github.com/callstack/react-native-paper/commits?author=Trancever" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=Trancever" title="Documentation">๐Ÿ“–</a></td>
86 <td align="center"><a href="https://twitter.com/esemesek"><img src="https://avatars2.githubusercontent.com/u/9092510?v=4" width="100px;" alt="Kacper Wiszczuk"/><br /><sub><b>Kacper Wiszczuk</b></sub></a><br /><a href="#ideas-Esemesek" title="Ideas, Planning, & Feedback">๐Ÿค”</a> <a href="https://github.com/callstack/react-native-paper/commits?author=Esemesek" title="Code">๐Ÿ’ป</a></td>
87 <td align="center"><a href="https://medium.com/@_happiryu"><img src="https://avatars1.githubusercontent.com/u/22746080?v=4" width="100px;" alt="Luke Walczak"/><br /><sub><b>Luke Walczak</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=lukewalczak" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=lukewalczak" title="Documentation">๐Ÿ“–</a></td>
88 <td align="center"><a href="https://github.com/ahmedlhanafy"><img src="https://avatars2.githubusercontent.com/u/7052827?v=4" width="100px;" alt="Ahmed Elhanafy"/><br /><sub><b>Ahmed Elhanafy</b></sub></a><br /><a href="#ideas-ahmedlhanafy" title="Ideas, Planning, & Feedback">๐Ÿค”</a> <a href="https://github.com/callstack/react-native-paper/commits?author=ahmedlhanafy" title="Code">๐Ÿ’ป</a></td>
89 <td align="center"><a href="https://github.com/kpsroka"><img src="https://avatars0.githubusercontent.com/u/24893014?v=4" width="100px;" alt="K. P. Sroka"/><br /><sub><b>K. P. Sroka</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=kpsroka" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=kpsroka" title="Documentation">๐Ÿ“–</a></td>
90 </tr>
91 <tr>
92 <td align="center"><a href="https://github.com/iyadthayyil"><img src="https://avatars2.githubusercontent.com/u/11161020?v=4" width="100px;" alt="Iyad Thayyil"/><br /><sub><b>Iyad Thayyil</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=iyadthayyil" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=iyadthayyil" title="Documentation">๐Ÿ“–</a></td>
93 <td align="center"><a href="http://hundeloh-consulting.ch/"><img src="https://avatars1.githubusercontent.com/u/5358638?v=4" width="100px;" alt="Julian Hundeloh"/><br /><sub><b>Julian Hundeloh</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=jaulz" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=jaulz" title="Documentation">๐Ÿ“–</a></td>
94 <td align="center"><a href="https://www.linkedin.com/in/grzegorzgawrysiak/"><img src="https://avatars3.githubusercontent.com/u/7827311?v=4" width="100px;" alt="Grzegorz Gawrysiak"/><br /><sub><b>Grzegorz Gawrysiak</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=gawrysiak" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=gawrysiak" title="Documentation">๐Ÿ“–</a></td>
95 <td align="center"><a href="https://github.com/luissmg"><img src="https://avatars2.githubusercontent.com/u/20660551?v=4" width="100px;" alt="Luรญs"/><br /><sub><b>Luรญs</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=luissmg" title="Code">๐Ÿ’ป</a></td>
96 <td align="center"><a href="https://raajnadar.in"><img src="https://avatars1.githubusercontent.com/u/17236768?v=4" width="100px;" alt="Rajendran Nadar"/><br /><sub><b>Rajendran Nadar</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=raajnadar" title="Code">๐Ÿ’ป</a></td>
97 <td align="center"><a href="https://github.com/brentvatne"><img src="https://avatars2.githubusercontent.com/u/90494?v=4" width="100px;" alt="Brent Vatne"/><br /><sub><b>Brent Vatne</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=brentvatne" title="Code">๐Ÿ’ป</a></td>
98 <td align="center"><a href="https://jukben.cz"><img src="https://avatars3.githubusercontent.com/u/8135252?v=4" width="100px;" alt="Jakub Beneลก"/><br /><sub><b>Jakub Beneลก</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=jukben" title="Code">๐Ÿ’ป</a></td>
99 </tr>
100 <tr>
101 <td align="center"><a href="https://twitter.com/_panpawel"><img src="https://avatars3.githubusercontent.com/u/3886886?v=4" width="100px;" alt="Paweล‚ Szymaล„ski"/><br /><sub><b>Paweล‚ Szymaล„ski</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=pan-pawel" title="Code">๐Ÿ’ป</a> <a href="https://github.com/callstack/react-native-paper/commits?author=pan-pawel" title="Documentation">๐Ÿ“–</a></td>
102 <td align="center"><a href="https://github.com/jayu"><img src="https://avatars1.githubusercontent.com/u/11561585?v=4" width="100px;" alt="Kuba"/><br /><sub><b>Kuba</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=jayu" title="Code">๐Ÿ’ป</a> <a href="#ideas-jayu" title="Ideas, Planning, & Feedback">๐Ÿค”</a></td>
103 <td align="center"><a href="https://github.com/jbinda"><img src="https://avatars2.githubusercontent.com/u/21242757?v=4" width="100px;" alt="jbinda"/><br /><sub><b>jbinda</b></sub></a><br /><a href="https://github.com/callstack/react-native-paper/commits?author=jbinda" title="Code">๐Ÿ’ป</a> <a href="#ideas-jbinda" title="Ideas, Planning, & Feedback">๐Ÿค”</a></td>
104 </tr>
105</table>
106
107<!-- ALL-CONTRIBUTORS-LIST:END -->
108
109This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!