# react-router-nest

> Animated screen transitions for React Router.

Latest version **1.1.0** (published 2019-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-router-nest
pnpm add react-router-nest
yarn add react-router-nest
bun add react-router-nest
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-05-15 |
| First published | 2019-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 36.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ozanbolel |
| Maintainers | ozanbolel |
| Keywords | react, reactjs, javascript, es6, css, css3, npm, frontend, animations |

## Links

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

## 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

- 1.1.0 (latest) — 2019-05-15
- 1.0.4 — 2019-05-12
- 1.0.3 — 2019-05-11
- 1.0.2 — 2019-05-11
- 1.0.1 — 2019-05-11
- 1.0.0 — 2019-05-11

## README

# react-router-nest

> Animated screen transitions for React Router.

[![npm](https://img.shields.io/npm/v/react-router-nest.svg)](https://www.npmjs.com/package/react-router-nest) [![npm bundle size](https://img.shields.io/bundlephobia/min/react-router-nest.svg)](https://www.npmjs.com/package/react-router-nest) [![npm downloads](https://img.shields.io/npm/dw/react-router-nest.svg)](https://www.npmjs.com/package/react-router-nest) ![last commit](https://img.shields.io/github/last-commit/ozanbolel/react-router-nest.svg) ![license](https://img.shields.io/npm/l/react-router-nest.svg)

**[Demo](https://ozanbolel.github.io/react-router-nest/)**

## Install

```bash
npm install --save react-router-nest
```

## Usage

```jsx
import React, { Component } from "react";
import Nest, { NestLink } from "react-nest";

class App extends Component {
  render () {
    return (
      <Nest>
        <NestLink props={ this.props } to="/AnotherScreen">Go to Another Screen</NestLink>
      </Nest>
    )
  }
}
```

> Screen-in and screen-out animations run on Nest. On clicking, NestLink redirects to the specified path.

## Properties

### Nest

|Prop|Description|Default|Required|
|---|---|:-:|:-:|
|**`animation`**|Name of the animation. Valid values: `fade` , `slide` , `zoom`|`fade`||
|**`duration`**|How long the animation will run. Valid values: `slow` , `normal` , `fast`|`normal`||
|**`className`**|Custom styles for the container.|||

### NestLink

|Prop|Description|Default|Required|
|---|---|:-:|:-:|
|**`props`**|Props of the component. Must be: `props={ this.props }`||YES|
|**`to`**|The path to link to.||YES|
|**`animation`**|Name of the animation. Valid values: `fade` , `slide` , `zoom`|Inherits from Nest||
|**`duration`**|How long the animation will run. Valid values: `slow` , `normal` , `fast`|Inherits from Nest||
|**`className`**|Custom styles for the container.|||

## License

[MIT](http://opensource.org/licenses/mit-license.html) © Ozan Bolel 2019

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