mirror of
https://github.com/status-im/react-navigation.git
synced 2025-02-24 09:08:15 +00:00
67 lines
4.8 KiB
Markdown
67 lines
4.8 KiB
Markdown
# React Navigation
|
|
|
|
[](https://badge.fury.io/js/react-navigation) [](https://codecov.io/gh/react-community/react-navigation) [](https://reactnavigation.org/docs/guides/contributors)
|
|
|
|
React Navigation is born from the React Native community's need for an extensible yet easy-to-use navigation solution based on Javascript.
|
|
|
|
## Installation
|
|
|
|
Since the library is a JS-based solution, to install the latest version of react-navigation you only need to run:
|
|
|
|
```bash
|
|
yarn add react-navigation
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
npm install --save react-navigation
|
|
```
|
|
|
|
## Documentation
|
|
|
|
* The best way to learn is to follow the [Getting started guide](https://reactnavigation.org/docs/getting-started.html). It guides you through the fundamentals of React Navigation.
|
|
* The documentation includes solutions for common use cases in the "How do I do ...?" section, such as [tab navigation](https://reactnavigation.org/docs/tab-based-navigation.html) and [Redux integration](https://reactnavigation.org/docs/redux-integration.html).
|
|
* If you need to build your own navigator, [there's a section for that](https://reactnavigation.org/docs/custom-navigator-overview.html) too.
|
|
* The [API reference](https://reactnavigation.org/docs/api-reference.html) lists all public APIs.
|
|
* The [Community Resources](https://github.com/react-navigation/react-navigation/blob/master/COMMUNITY_RESOURCES.md) document lists some other resources submitted to us by people who use React Navigation. Feel free to open a pull request to add your resource to the list.
|
|
* You can contribute improvements to the documentation [in the website repository](https://github.com/react-navigation/react-navigation.github.io).
|
|
|
|
## Try it out
|
|
|
|
You can also try out the [Navigation Playground app](https://exp.host/@react-navigation/NavigationPlayground) to get a sense for some of the tools built in to React Navigation. The "Fundamentals" in the documentation also include examples you can play with.
|
|
|
|
## FAQs
|
|
|
|
#### I'm having troubles using the library, what can I do?
|
|
|
|
See [the help page](https://reactnavigation.org/en/help.html).
|
|
|
|
#### How can I help?
|
|
|
|
Glad you ask! This library is a community effort: it can only be great if we all help out in one way or another 😄 . If you feel like you aren't experienced enough using react navigation to contribute, you can still make an impact by:
|
|
|
|
* Responding to one of the open [issues](https://github.com/react-community/react-navigation/issues). Even if you can't resolve or fully answer a question, asking for more information or clarity on an issue is extremely beneficial for someone to come after you to resolve the issue.
|
|
* Creating public example repos of navigation problems you have solved.
|
|
* Answering questions on [Stack Overflow](https://stackoverflow.com/search?q=react-navigation). Alternatively, asking questions on Stack Overflow instead of opening an issue.
|
|
* Answering questions in our [Reactiflux](https://www.reactiflux.com/) channel.
|
|
* Providing feedback on the open [PRs](https://github.com/react-community/react-navigation/pulls).
|
|
|
|
If you would like to submit a pull request, please follow the [Contributors guide](https://reactnavigation.org/docs/contributing.html) to find out how. If you don't know where to start, check the ones with the label [`good first issue`](https://github.com/react-community/react-navigation/labels/good%20first%20issue) - even [fixing a typo in the documentation](https://github.com/react-community/react-navigation/pull/2727) is a worthy contribution!
|
|
|
|
#### Is this the only library available for navigation?
|
|
|
|
No: there are some other libraries - which, depending on your project, can be better or worse suited for your project. Read more in the [alternative libraries](https://reactnavigation.org/docs/alternatives.html) documentation, and read React Navigation's [pitch & anti-pitch](https://reactnavigation.org/docs/pitch.html) to understand the tradeoffs.
|
|
|
|
#### Can I use this library for web?
|
|
|
|
This library originally planned to support web too - but at the moment [it is not a priority](https://github.com/react-community/react-navigation/issues/2585#issuecomment-330338793) for v1.0; a lot of work is necessary to reach it as-is and we had to freeze this support (consider it "experimental").
|
|
|
|
## Code of conduct
|
|
|
|
This library has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://github.com/react-community/react-navigation/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
|
|
|
|
## License
|
|
|
|
React-navigation is licensed under the [BSD 2-clause "Simplified" License](https://github.com/react-community/react-navigation/blob/master/LICENSE).
|