react-router-last-location

by hinok

Provides access to the last location in react + react-router (v4.x, v5.x) applications. ❤️ Using hoo...

237 Stars 9 Forks Last release: Not found MIT License 68 Commits 12 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Build Status Coverage Status

react-router-last-location

  • Provides access to the last location in
    react
    +
    react-router (v4.x, v5.x)
    applications.
  • ❤️ Using
    hooks
    ? If yes,
    useLastLocation
    .
  • 💉 Using
    HOC
    ? - If yes,
    withLastLocation
    .
  • Handle redirects.
  • Support TypeScript
  • Useful for handling internal routing.
  • Easily keep your users inside your app.

Demo

Edit react-router-last-location

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
  5. 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?

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

npm install [email protected]^2.0.0
# or
npm install [email protected]

Declare
 inside 
.

index.js
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
    <hr>

    <route exact path="/" component="{Home}"></route>
    <route path="/about" component="{About}"></route>
    <route path="/contact" component="{Contact}"></route>

    <hr>

    <logger></logger>
  </div>
</lastlocationprovider>
);

render(, document.getElementById('root'));

Use hook
useLastLocation
to get
lastLocation
.

./components/Logger
, see example
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
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

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:
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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.