# react-navigation

> Routing and navigation for your React Native apps

Latest version **5.0.0** (published 2023-09-25) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install react-navigation
pnpm add react-navigation
yarn add react-navigation
bun add react-navigation
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2023-09-25 |
| First published | 2016-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/react-navigation) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 698 B |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Adam Miskiewicz |
| Maintainers | okwasniewski, kacperkapusciak, ericvicenti, brentvatne, satya164, osdnk, grabbou, skevy |

## Links

- npm: https://www.npmjs.com/package/react-navigation
- Repository: https://github.com/react-navigation/react-navigation
- Homepage: https://github.com/react-navigation/react-navigation#readme
- Issues: https://github.com/react-navigation/react-navigation/issues
- npm.io page: https://npm.io/package/react-navigation

## Recent versions

- 5.0.0 (latest) — 2023-09-25
- 4.1.0-alpha.1 (alpha) — 2019-09-13
- 3.12.0-alpha.0 (next) — 2019-08-17
- 2.18.3 (legacy) — 2018-11-26
- 1.1.0-alpha.2 (text) — 2018-02-14
- 4.4.4 — 2021-02-21
- 4.4.3 — 2020-10-26
- 4.4.2 — 2020-10-02
- 4.4.1 — 2020-09-24
- 4.4.0 — 2020-06-25
- 4.3.9 — 2020-04-30
- 4.3.8 — 2020-04-22
- 4.3.7 — 2020-04-02
- 4.3.6 — 2020-03-31
- 4.3.5 — 2020-03-28
- … 256 more at https://npm.io/package/react-navigation/versions

## README

# React Navigation 8

[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
[![MIT License][license-badge]][license]

Routing and navigation for your React Native apps.

Documentation can be found at [reactnavigation.org](https://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](https://github.com/react-navigation/react-navigation/tree/7.x) (latest stable)
- [6.x](https://github.com/react-navigation/react-navigation/tree/6.x)
- [5.x](https://github.com/react-navigation/react-navigation/tree/5.x)
- [4.x](https://github.com/react-navigation/react-navigation/tree/4.x)
- [3.x](https://github.com/react-navigation/react-navigation/tree/3.x)
- [2.x](https://github.com/react-navigation/react-navigation/tree/2.x)
- [1.x](https://github.com/react-navigation/react-navigation/tree/1.x)

## Package Versions

| Name                                                                         |                                                                      Latest Version                                                                       |
| ---------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [@react-navigation/bottom-tabs](/packages/bottom-tabs)                       |          [![badge](https://img.shields.io/npm/v/@react-navigation/bottom-tabs.svg)](https://www.npmjs.com/package/@react-navigation/bottom-tabs)          |
| [@react-navigation/core](/packages/core)                                     |                 [![badge](https://img.shields.io/npm/v/@react-navigation/core.svg)](https://www.npmjs.com/package/@react-navigation/core)                 |
| [@react-navigation/devtools](/packages/devtools)                             |             [![badge](https://img.shields.io/npm/v/@react-navigation/devtools.svg)](https://www.npmjs.com/package/@react-navigation/devtools)             |
| [@react-navigation/drawer](/packages/drawer)                                 |               [![badge](https://img.shields.io/npm/v/@react-navigation/drawer.svg)](https://www.npmjs.com/package/@react-navigation/drawer)               |
| [@react-navigation/elements](/packages/elements)                             |             [![badge](https://img.shields.io/npm/v/@react-navigation/elements.svg)](https://www.npmjs.com/package/@react-navigation/elements)             |
| [@react-navigation/material-top-tabs](/packages/material-top-tabs)           |    [![badge](https://img.shields.io/npm/v/@react-navigation/material-top-tabs.svg)](https://www.npmjs.com/package/@react-navigation/material-top-tabs)    |
| [@react-navigation/native-stack](/packages/native-stack)                     |            [![badge](https://img.shields.io/npm/v/@react-navigation/native-stack.svg)](https://www.npmjs.com/package/@react-navigation/native-stack)             |
| [@react-navigation/native](/packages/native)                                 |               [![badge](https://img.shields.io/npm/v/@react-navigation/native.svg)](https://www.npmjs.com/package/@react-navigation/native)               |
| [@react-navigation/routers](/packages/routers)                               |              [![badge](https://img.shields.io/npm/v/@react-navigation/routers.svg)](https://www.npmjs.com/package/@react-navigation/routers)              |
| [@react-navigation/stack](/packages/stack)                                   |                [![badge](https://img.shields.io/npm/v/@react-navigation/stack.svg)](https://www.npmjs.com/package/@react-navigation/stack)                |
| [react-native-drawer-layout](/packages/react-native-drawer-layout) |        [![badge](https://img.shields.io/npm/v/react-native-drawer-layout.svg)](https://www.npmjs.com/package/react-native-drawer-layout)        |
| [react-native-tab-view](/packages/react-native-tab-view) |        [![badge](https://img.shields.io/npm/v/react-native-tab-view.svg)](https://www.npmjs.com/package/react-native-tab-view)        |

## Contributing

Please read through our [contribution guide](CONTRIBUTING.md) 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`](https://github.com/ramasilveyra/gitpkg).

First install `gitpkg`:

```sh
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
1. Open a Terminal and `cd` to the location of the cloned repo
1. Run `pnpm install` to install any dependencies
1. If you want to make any changes, make them and commit
1. Run `pnpm lerna run prepack` to perform the build steps
1. Now `cd` to the package directory that you want to use (e.g. `cd packages/stack` for `@react-navigation/stack`)
1. Run `gitpkg publish` to publish the package to your repo

After publishing, you should see something like this:

```sh
Package uploaded to git@github.com:<user>/<repo>.git with the name <name>
```

You can now install the dependency in your project:

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

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

<!-- badges -->

[build-badge]: https://github.com/react-navigation/react-navigation/actions/workflows/ci.yml/badge.svg
[build]: https://github.com/react-navigation/react-navigation/actions/workflows/ci.yml
[coverage-badge]: https://img.shields.io/codecov/c/github/react-navigation/react-navigation.svg
[coverage]: https://codecov.io/github/react-navigation/react-navigation
[license-badge]: https://img.shields.io/npm/l/@react-navigation/core.svg
[license]: https://opensource.org/licenses/MIT

---
_Source: https://npm.io/package/react-navigation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
