https://github.com/fi3ework/mova
[WIP] more easy and better way to play with MobX
https://github.com/fi3ework/mova
Last synced: over 1 year ago
JSON representation
[WIP] more easy and better way to play with MobX
- Host: GitHub
- URL: https://github.com/fi3ework/mova
- Owner: fi3ework
- License: mit
- Created: 2019-01-13T14:45:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-25T03:51:12.000Z (over 7 years ago)
- Last Synced: 2024-10-19T19:58:26.121Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 310 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An enhanced version of **react-router-v4 Route** Component that keeps route component alive on unmatched path and restore it completely on match path.
## Document
[中文](./docs/README-zh.md)
## Demo
### codeSandbox
You can experience and review the source code on codeSandbox.
[](https://codesandbox.io/s/yj9j33pw4j)
### QR code
You also can scan the QR code of the demo above to experience it on mobile device.
## Install
```bash
npm install react-live-route
```
or
```bash
yarn add react-live-route
```
## About
It will hide component of route instead of unmout it when the path is not match and restore it when come back. There are a few APIs provided to control the hidden condition of component.
Example：
There is a item list page, click on the items on this page will enter the item detail page. When entering the detail page, item list page will be hidden and it will keep hidden when you are on item detail page. Once back to the list page, the list page will be restored to the last state of leaving.
## Features
- ✅ Fully compatible with react-router-v4, all passed the react-router-v4 unit tests.
- 🎯 Completely restored to the state of the last time you left (scroll position included).
- 🔒 Minimally invasive, all you need to do is import LiveRoute.
- ✌️ Super easy API.
## Caveat ⚠️
- LiveRoute **SHOULD NOT** be wrapped by `Switch` directly, cause `Switch` only render the first matched child element so that LiveRoute may be skipped directly. You can move LiveRoute from `Switch` to the outside.
- If LiveRoute's parent route is unmounted on current location, then it will also be unmounted . This is determined by the top-down design principle of React. You can use LiveRoute to declares a parent route to solve this problem or stop nestting the router.
- In some cases the DOM of LiveRoute will be modified directly and the scroll position will not change when navigation. This is not a problem with react-live-route. You can scroll the screen to the top manually and you may get some help from [this article](https://github.com/ReactTraining/react-router/blob/2b94b8f9e115bec6426be06b309b6963f4a96004/packages/react-router-dom/docs/guides/scroll-restoration.md) from react-router. By the way, if the scroll position will be restored by LiveRoute, it will come up after the scroll operation in componet of LiveRoute due to the render order of React.
## Usage
### livePath: string or array
`livePath` is the path you want to hide the component instead of unmount it. The specific rules of `livePath` are the same as `path` props of Route in react-router-v4. You still can use `component` or `render` props to render a component.
`livePath` also can accept an array of string above since 1.2.0. `livePath` is matched if any string in the array is matched.
LiveRoute will re-render when it come back from a `path` matching location from the `livePath` matching location. It will unmount on other unmatched locations.
Example:
The route of List will be rendered normally under `/list`, and it will be hidden when location change to `/user/:id`, and it will be unmounted normally when entering other locations.
```jsx
import LiveRoute from 'react-live-route'
```
### alwaysLive: bool
`alwaysLive` is just like `livePath`. The difference is the component will not be unmount on **any other location** after the it's first mount.
Example:
After the first mount on match location, the Modal page will be hidden when the path is not matched, and will re-render when `path` match again.
```jsx
import LiveRoute from 'react-live-route'
```
### onHide: (routeState: {location, livePath, alwaysLive}) => any
This hook will be triggered when LiveRoute will hide in `componentWillReceiveProps` stage (so it happens before re-render).
### onReappear: (routeState: {location, livePath, alwaysLive}) => any
This hook will be triggered when LiveRoute will reappear from hide in `componentWillReceiveProps` stage (so it happens before re-render).
## TODO
- [ ] add test case
- [ ] add forceUnmount prop
## Licence
MIT