Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hinok/react-router-last-location
Provides access to the last location in react + react-router (v4.x, v5.x) applications. ❤️ Using hooks? useLastLocation | 💉 Using HOC? withLastLocation
https://github.com/hinok/react-router-last-location
history last-location location react react-router reactjs
Last synced: 6 days ago
JSON representation
Provides access to the last location in react + react-router (v4.x, v5.x) applications. ❤️ Using hooks? useLastLocation | 💉 Using HOC? withLastLocation
- Host: GitHub
- URL: https://github.com/hinok/react-router-last-location
- Owner: hinok
- License: mit
- Created: 2017-05-23T10:02:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:23:16.000Z (about 2 years ago)
- Last Synced: 2024-10-30T00:36:46.262Z (2 months ago)
- Topics: history, last-location, location, react, react-router, reactjs
- Language: TypeScript
- Homepage:
- Size: 1.53 MB
- Stars: 284
- Watchers: 4
- Forks: 24
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/hinok/react-router-last-location)
[](https://coveralls.io/github/hinok/react-router-last-location?branch=master)
# react-router-last-location
- Provides access to the last location in `react` + `react-router (v4.x, v5.x)` applications.
- ❤️ Using [`hooks`](https://reactjs.org/docs/hooks-overview.html)? If yes, `useLastLocation`.
- 💉 Using [`HOC`](https://reactjs.org/docs/higher-order-components.html)? - If yes, `withLastLocation`.
- Handle redirects.
- Support 
- Useful for handling internal routing.
- Easily keep your users inside your app.
## Demo
[](https://codesandbox.io/s/zn208l91zp)
## Note: Last location != Previous browser history state
This library only returns the location that was active right before the recent location change, during the lifetime of the current window.
This means, it is not equal to the "location you were at before navigating to this history state".
In other words, the location this library provides is not necessarily the same as the one when you click the browser's back button.
**Example 1**
1. Visit `/`: last location = `null`, previous browser history state = `null`
2. Visit `/a`: last location = `/`, previous browser history state = `/`
3. Visit `/b`: last location = `/a`, previous browser history state = `/a`
4. Reload (url will stay at `/b`): last location = `null`, previous browser history state = `/a`
**Example 2**
1. Visit `/`: last location = `null`
2. Visit `/a`: last location = `/`
3. Visit `/b`: last location = `/a`
4. Go back: last location = `/b`, previous browser history state = `/`
**Example 3**
1. Visit `/`: last location = `null`
2. Visit `/a`: last location = `/`
3. Visit `/b`: last location = `/a`
4. Visit `/c`: last location = `/b`
4. Go back to `/a` (by selecting that state explicitly in "Go back" browser dropdown that is visible upon clicking it with right mouse button): last location = `/c`, previous browser history state = `/`
## How to use?
```bash
# Please remember that you should have installed react, prop-types and react-router-dom packages
# npm install react prop-types react-router-dom --save
npm install react-router-last-location --save
```
**If you still use `v1.x.x` and would like to use hook `useLastLocation`, please upgrade to `v2.x.x` version (don't worry, no breaking changes).**
```bash
npm install react-router-last-location@^2.0.0
# or
npm install react-router-last-location@latest
```
### Declare `` inside ``.
`index.js`
```jsx
import React from 'react';
import { render } from 'react-dom';
import { BrowserRouter as Router, Route, Link } from 'react-router-dom';
import { LastLocationProvider } from 'react-router-last-location';
import Home from './pages/Home';
import About from './pages/About';
import Contact from './pages/Contact';
import Logger from './components/Logger';
const App = () => (
- Home
- About
- Contact
);
render(, document.getElementById('root'));
```
### Use hook `useLastLocation` to get `lastLocation`.
`./components/Logger`, [see example](https://github.com/hinok/react-router-last-location/blob/eb552e0a82df6000ba140d8f20627b8bc68716b6/example/src/components/LoggerHooks/index.js)
```jsx
import React from 'react';
import { useLastLocation } from 'react-router-last-location';
const Logger = () => {
const lastLocation = useLastLocation();
return (
Logger!
{JSON.stringify(lastLocation)}
);
};
export default LoggerHooks;
```
### Use HOC `withLastLocation` to get `lastLocation` prop.
`./components/Logger`, [see example](https://github.com/hinok/react-router-last-location/blob/eb552e0a82df6000ba140d8f20627b8bc68716b6/example/src/components/LoggerHOC/index.js)
```jsx
import React from 'react';
import { withLastLocation } from 'react-router-last-location';
const Logger = ({ lastLocation }) => (
Logger!
{JSON.stringify(lastLocation)}
);
export default withLastLocation(Logger);
```
### Use `RedirectWithoutLastLocation` to not store redirects as last location
```jsx
import React from 'react';
import { RedirectWithoutLastLocation } from 'react-router-last-location';
const MyPage = () => (
);
export default MyPage;
```
You can still use a regular `` component from `react-router`.
If you do, you'll then you need to manually pass the `state: { preventLastLocation: true }`, like below:
```jsx
import React from 'react';
import { Redirect } from 'react-router-dom';
const MyPage = () => (
);
export default MyPage;
```
## LastLocationProvider
### Props
**`watchOnlyPathname`**, type: `boolean`, default: `false`
Stores the last route only when `pathname` has changed.