Routing and navigation for your React Native apps
Branch: master
Clone or download
Pull request Compare This branch is 10 commits behind react-navigation:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
examples/NavigationPlayground
flow
scripts
src
.babelrc
.codecov.yml
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmignore
.release-it.json
.watchmanconfig
CHANGELOG.md
CODE_OF_CONDUCT.md
COMMUNITY_RESOURCES.md
CONTRIBUTING.md
LICENSE
NavigationTestUtils.js
README.md
assetsTransformer.js
jest-setup.js
package.json
prettier.config.js
yarn.lock

README.md

React Navigation

npm version CircleCI badge PRs Welcome

React Navigation is born from the React Native community's need for an extensible yet easy-to-use navigation solution based on Javascript.

Installation

See: https://reactnavigation.org/docs/en/getting-started.html

Documentation

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?

See our Contributing Guide!

Is this the only library available for navigation?

Certainly not! There other libraries - which, depending on your needs, 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?

Web support was not a priority for the 1.0 release, but the architecture of this library allows for it (and it has worked in the past). If you would like to lead this charge, please reach out with your ideas for how to move forward on the RFCs repository and we would be happy to discuss.

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.