# react-navigate

> Navigation on web for React.JS

Latest version **0.6.0** (published 2017-10-14) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2017-10-14 |
| First published | 2016-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | xiaody |
| Maintainers | xiaody |
| Keywords | react, navigation, controller, navigator, component |

## Links

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

## Dependencies (1)

- [throttleit](https://npm.io/package/throttleit.md) 1.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.6.0 (latest) — 2017-10-14
- 0.5.1 — 2017-05-14
- 0.4.6 — 2016-12-30
- 0.4.5 — 2016-12-21
- 0.4.4 — 2016-12-20
- 0.4.3 — 2016-12-20
- 0.4.1 — 2016-12-20
- 0.3.0 — 2016-12-19
- 0.2.0 — 2016-12-17
- 0.1.0 — 2016-12-17

## README

[![dependencies Status](https://david-dm.org/xiaody/react-navigate/status.svg)](https://david-dm.org/xiaody/react-navigate)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

# react-navigate

Navigation on web for React.JS https://xiaody.github.io/react-navigate

## Installation

To install the stable version:

```
npm install --save react-navigate
```

## Usage

```jsx
import Navigation, {NavLink} from 'react-navigate'
import 'react-navigate/src/Navigation.css'

const views = {
  home: {
    name: 'home',
    title: 'Home page',
    content () {
      return (
        <NavLink to='about'>go to About</NavLink>
      )
    }
  },
  about: {
    name: 'about',
    title: 'Abount',
    content: 'Oh!'
  }
}

<Navigation
  viewsMap={views}
  defaultViewName='home'
/>
```

## Options

- props.viewsMap
- props.defaultViewName
- props.height
- props.headerHeight
- props.backButton
- props.className
- props.titleClassName
- props.bodyClassName
- props.onWillNav
- props.onDidNav

## Limitations

- scroll position isn't kept when switching between views, because the DOM is destroyed and re-created
- no back button title support
- require modern browsers env

## License

MIT

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