JavaScript Other
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci First crack at publish from circle (#3574) Feb 23, 2018
.github Update ISSUE_TEMPLATE.md (#4575) Jun 25, 2018
examples Move more logs behind debug flag in stack playground Jul 24, 2018
flow [flow] Make NavigationRoute types exact (#4667) Jul 10, 2018
scripts Temporarily stop running flow on navigation playground due to interna… Jun 1, 2018
src Extract stack to react-navigation-stack (#4809) Aug 4, 2018
.babelrc Clean up old build process and Babel config (#3406) Feb 2, 2018
.codecov.yml Add codecov.yml May 15, 2017
.editorconfig Introducing flat options (#984) Apr 12, 2017
.eslintignore Add Flow libdef (#3391) Feb 1, 2018
.eslintrc Transitioner: Fix instantaneous transitions (#4404) Jun 4, 2018
.gitignore Clean up old build process and Babel config (#3406) Feb 2, 2018
.npmignore Exclude __tests__ from published files (#1525) May 15, 2017
.watchmanconfig Initial public release of React Navigation Jan 26, 2017
CHANGELOG.md Extract stack to react-navigation-stack (#4809) Aug 4, 2018
CODE_OF_CONDUCT.md Add CoC Jun 15, 2017
COMMUNITY_RESOURCES.md Update README Feb 3, 2018
CONTRIBUTING.md Move contributing guide to CONTRIBUTING.md (#3631) Mar 1, 2018
LICENSE Initial public release of React Navigation Jan 26, 2017
NavigationTestUtils.js Add NavigationTestUtils and release 2.9.3 Jul 26, 2018
README.md Use consistent naming in README (#4427) Jun 5, 2018
assetsTransformer.js Fix "npm test" on Windows 10 (#4066) Apr 27, 2018
jest-setup.js Remove flow (#3350) Jan 25, 2018
package.json Bump react-native-safe-area-view dep to 0.9.0 (#4810) Aug 7, 2018
prettier.config.js Navigation Event Subscriptions (#3345) Jan 25, 2018
yarn.lock Extract stack to react-navigation-stack (#4809) Aug 4, 2018

README.md

React Navigation

npm version codecov 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

Since the library is a JS-based solution, to install the latest version of react-navigation you only need to run:

yarn add react-navigation

or

npm install --save react-navigation

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.