Routing and navigation for your React Native apps.
Documentation can be found at reactnavigation.org.
This branch contains the code for the latest stable version of React Navigation. You can find the code for previous versions in the following branches:
Please read through our contribution guide to get started!
Since we use a monorepo, it's not possible to install a package from the repository URL. If you need to install a forked version from Git, you can use gitpkg
.
First install gitpkg
:
yarn global add gitpkg
Then follow these steps to publish and install a forked package:
- Fork this repo to your account and clone the forked repo to your local machine
- Open a Terminal and
cd
to the location of the cloned repo - Run
yarn
to install any dependencies - If you want to make any changes, make them and commit
- Run
yarn lerna run prepack
to perform the build steps - Now
cd
to the package directory that you want to use (e.g.cd packages/stack
for@react-navigation/stack
) - Run
gitpkg publish
to publish the package to your repo
After publishing, you should see something like this:
Package uploaded to git@github.com:<user>/<repo>.git with the name <name>
You can now install the dependency in your project:
yarn add <user>/<repo>.git#<name>
Remember to replace <user>
, <repo>
and <name>
with right values.