Skip to content
Routing and navigation for your React Native apps
TypeScript Other
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore: improve caching of yarn on circleci May 27, 2020
.github chore: try to fix yarn caching on gh actions May 27, 2020
.yarn/releases chore: lock yarn version Feb 10, 2020
example chore: tweak SSR output May 27, 2020
jest Correcting spelling 'Supress' > 'Suppress' (#7731) Mar 6, 2020
packages chore: publish May 27, 2020
scripts chore: update prettier Mar 22, 2020
.eslintignore refactor: move types and base router to routers package Feb 10, 2020
.eslintrc.json chore: remove native-stack from the repo Feb 19, 2020
.gitattributes chore: mark yarn script as binary Feb 24, 2020
.gitignore feat: add safeAreaInsets to bottom tabs Mar 9, 2020
.watchmanconfig chore: setup monorepo with yarn workspaces (#38) Aug 1, 2019
.yarnrc chore: lock yarn version Feb 10, 2020
CONTRIBUTING.md chore: add release script Feb 19, 2020
README.md chore: update contributing guidelines Feb 10, 2020
babel.config.js feat: add error if multiple instances of useLinking are used (#310) Jan 29, 2020
commitlint.config.js chore: upgrade eslint config Sep 28, 2019
lerna.json chore: prepare for stable release (#354) Feb 5, 2020
netlify.toml chore: add config for netlify Apr 12, 2020
package.json chore: fix repo url in readme (#8235) May 14, 2020
tsconfig.json fix: make sure paths aren't aliased when building definitions Jan 13, 2020
yarn.lock chore: add an example for SSR (#8298) May 26, 2020

README.md

React Navigation 5

Build Status Code Coverage MIT License

Routing and navigation for your React Native apps.

Documentation can be found at reactnavigation.org.

If you are looking for version 4, the code can be found in the 4.x branch.

Contributing

Please read through our contribution guide a 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:

yarn global add 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 yarn to install any dependencies
  4. If you want to make any changes, make them and commit
  5. Now cd to the package directory that you want to use (e.g. cd packages/stack for @react-navigation/stack)
  6. 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.

You can’t perform that action at this time.