react-navigation

The best way to learn is to follow the Getting started guide. 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 and Redux integration.
If you need to build your own navigator, there's a section for that too.
The API reference lists all public APIs.
The Community Resources 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.

Try it out

You can also try out the Navigation Playground app 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.

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. 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. Alternatively, asking questions on Stack Overflow instead of opening an issue.
Answering questions in our Reactiflux channel.
Providing feedback on the open PRs.

If you would like to submit a pull request, please follow the Contributors guide to find out how. If you don't know where to start, check the ones with the label good first issue - even fixing a typo in the documentation is a worthy contribution!

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 documentation, and read React Navigation's pitch & anti-pitch 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 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 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.

README.md

React Navigation

Installation

Documentation