# router-store

> Keep your history in sync with react-router

Latest version **3.0.0** (published 2020-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install router-store
pnpm add router-store
yarn add router-store
bun add router-store
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-10-27 |
| First published | 2019-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | caijf |
| Maintainers | caijf |
| Keywords | react, router, react-router, router-store, store |

## Links

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

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

- 3.0.0 (latest) — 2020-10-27
- 2.0.0 — 2019-12-05
- 1.0.1 — 2019-12-05
- 0.0.0 — 2019-12-05

## README

# router-store

保持你的历史记录与 `react-router` 同步，参考了 [mobx-react-router](https://github.com/alisd23/mobx-react-router) 。

项目中同步你的历史记录是很有必要的。比如你在请求模块中判断登录超时，直接跳转到登录页。

## 安装

```shell
npm install router-store
```

## 使用

在配置页面路由的地方，同步历史记录。

`index.js`

```javascript
import React from 'react';
import ReactDOM from 'react-dom';
import { createHashHistory } from "history";
import { Router } from 'react-router';
import { syncRouterHistory } from "router-store";

const hashHistory = createHashHistory();

syncRouterHistory(hashHistory);

ReactDOM.render(
  <Router history={hashHistory}>
    {
      // 页面路由
    }
  </Router>,
  document.getElementById('root')
);
```

`request.js`

```javascript
import axios from "axios";
import { routerHistory } from 'router-store';

export default function request(){
  return axios({
    // ...
  }).then((res)=>{
    // 如果登录过期
    if(res.data.errCode === '-1'){
      routerHistory.push('/login');
    }
  })
}
```

## API

### syncRouterHistory(history: any, key?: string)

同步 `Router` 的 `history` 。

- `history` - [history](https://github.com/ReactTraining/history) 对象。
- `key` - 可选，用于多个 `history` 实例的键值。

### routerHistory

`history`  对象。

### getRouterHistory(key?:string)

获取 `history` 。

## 示例：多个 `history` 

`parentView.js`

```javascript
// ...
import { createHashHistory } from "history";
import { syncRouterHistory } from "router-store";

const hashHistory = createHashHistory();

syncRouterHistory(hashHistory, 'parent');

ReactDOM.render(
  <Router history={hashHistory}>
    {
      // 页面路由
    }
  </Router>,
  document.getElementById('root')
);
```

`childView.js`

```javascript
// ...
import { createHashHistory } from "history";
import { syncRouterHistory } from "router-store";

const hashHistory = createHashHistory();

syncRouterHistory(hashHistory, 'child');

ReactDOM.render(
  <Router history={history}>
    {
      // 页面路由
    }
  </Router>,
  document.getElementById('root')
);
```

`request.js`

```javascript
import { getRouterHistory } from 'router-store';

const parentRouterHistory = getRouterHistory('parent');
const childRouterHistory = getRouterHistory('child');
```

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