# react-navigation-drawer

> Drawer navigator component for React Navigation

Latest version **2.7.2** (published 2022-02-02) · MIT license · 0 weekly downloads

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

## Install

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

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.7.2 |
| Published | 2022-02-02 |
| First published | 2018-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 374.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 142 |
| Maintainers | brentvatne, satya164, osdnk |
| Keywords | react-native-component, react-component, react-native, ios, android, drawer, material |

## Links

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

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.7.2 (latest) — 2022-02-02
- 1.4.0 (legacy) — 2019-08-23
- 1.3.0-alpha.0 (next) — 2019-08-14
- 2.7.1 — 2021-04-24
- 2.7.0 — 2021-02-21
- 2.6.0 — 2020-10-26
- 2.5.2 — 2020-10-02
- 2.5.1 — 2020-09-24
- 2.5.0 — 2020-06-25
- 2.4.13 — 2020-04-30
- 2.4.12 — 2020-04-22
- 2.4.11 — 2020-04-02
- 2.4.10 — 2020-03-31
- 2.4.9 — 2020-03-28
- 2.4.8 — 2020-03-27
- … 53 more at https://npm.io/package/react-navigation-drawer/versions

## README

# React Navigation Drawer

[![npm version](https://badge.fury.io/js/react-navigation-drawer.svg)](https://npmjs.org/react-navigation-drawer) [![CircleCI badge](https://circleci.com/gh/react-navigation/drawer/tree/master.svg?style=shield)](https://circleci.com/gh/react-navigation/drawer/tree/master) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactnavigation.org/docs/contributing.html)

Drawer navigator for use on iOS and Android.

## Installation

Open a Terminal in the project root and run:

```sh
yarn add react-navigation-drawer
```

If you are using Expo, you are done. Otherwise, continue to the next step.

Install and link [`react-native-gesture-handler`](https://github.com/kmagiera/react-native-gesture-handler) and [`react-native-reanimated`](https://github.com/kmagiera/react-native-reanimated). To install and link them, run:

```sh
yarn add react-native-reanimated react-native-gesture-handler
react-native link react-native-reanimated
react-native link react-native-gesture-handler
```

**IMPORTANT:** There are additional steps required for `react-native-gesture-handler` on Android after running `react-native link react-native-gesture-handler`. Check the [this guide](https://kmagiera.github.io/react-native-gesture-handler/docs/getting-started.html) to complete the installation.

## Usage

```js
import { createDrawerNavigator } from 'react-navigation-drawer';

export default createDrawerNavigator({
  Inbox: InboxStack
  Drafts: DraftsStack,
}, {
  initialRouteName: 'Inbox',
  contentOptions: {
    activeTintColor: '#e91e63',
  },
});
```

## Development workflow

- Clone this repository
- Run `yarn` in the root directory and in the `example` directory
- Run `yarn dev` in the root directory
- Run `yarn start` in the `example` directory

## Docs

Documentation can be found on the [React Navigation website](https://reactnavigation.org/docs/en/drawer-navigator.html).

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