React Navigation 8

Routing and navigation for your React Native apps.

Documentation can be found at reactnavigation.org.

This branch contains the code for the upcoming major version of React Navigation. You can find the code for other versions in the following branches:

• 7.x (latest stable)
• 6.x
• 5.x
• 4.x
• 3.x
• 2.x
• 1.x

Package Versions

| Name | Latest Version | | ---------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | | @react-navigation/bottom-tabs | | | @react-navigation/core | | | @react-navigation/devtools | | | @react-navigation/drawer | | | @react-navigation/elements | | | @react-navigation/material-top-tabs | | | @react-navigation/native-stack | | | @react-navigation/native | | | @react-navigation/routers | | | @react-navigation/stack | | | react-native-drawer-layout | | | react-native-tab-view | |

Contributing

Please read through our contribution guide to get started!

Installing from a fork on GitHub

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:

pnpm add --global gitpkg

Then follow these steps to publish and install a forked package:

1. Fork this repo to your account and clone the forked repo to your local machine
2. Open a Terminal and cd to the location of the cloned repo
3. Run pnpm install to install any dependencies
4. If you want to make any changes, make them and commit
5. Run pnpm lerna run prepack to perform the build steps
6. Now cd to the package directory that you want to use (e.g. cd packages/stack for @react-navigation/stack)
7. 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:

pnpm add <user>/<repo>.git#<name>

Remember to replace <user>, <repo> and <name> with right values.