Skip to content
Routing and navigation for your React Native apps
TypeScript JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore: prepare for 4.x Aug 31, 2019
.github chore: close stale issues automatically Nov 18, 2019
example docs: add the readme back into example (#6284) Sep 16, 2019
src fix: update link to docs page from deprecation messages Sep 26, 2019
typescript fix: remove params in NavigationJumpToAction (#6360) Oct 16, 2019
typings chore: prepare for 4.x Aug 31, 2019
.codecov.yml Add codecov.yml May 15, 2017
.editorconfig Introducing flat options (#984) Apr 12, 2017
.eslintignore [flow] Remove Flow libdef from repo (#6327) Sep 26, 2019
.eslintrc chore: prepare for 4.x Aug 31, 2019
.gitignore Release 3.10.0 May 16, 2019
.npmignore Exclude __tests__ from published files (#1525) May 15, 2017
.release-it.json chore: prepare for 4.x Aug 31, 2019
.watchmanconfig Initial public release of React Navigation Jan 26, 2017
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 chore: prepare for 4.x Aug 31, 2019
NavigationTestUtils.js ./src/createNavigationContainer -> @react-navigation/native/src/creat… Nov 26, 2018
README.md docs: add Changelog information to README (#6264) Sep 7, 2019
assetsTransformer.js chore: prepare for 4.x Aug 31, 2019
babel.config.js chore: prepare for 4.x Aug 31, 2019
commitlint.config.js chore: prepare for 4.x Aug 31, 2019
jest-setup.js chore: prepare for 4.x Aug 31, 2019
package.json chore: release 4.0.10 Sep 26, 2019
prettier.config.js chore: prepare for 4.x Aug 31, 2019
tsconfig.json chore: prepare for 4.x Aug 31, 2019
yarn.lock fix: update react-navigation/core Sep 14, 2019

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

Changelog

The changes for each release are outlined on the Github releases page.

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 are 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 MIT.

You can’t perform that action at this time.