donus3/react-last-location-router

Provides access to the last location in react + react-router (v6.x) apps. Useful for handling internal routing. Easily prevent leaving your app by users.

react-router-dom-last-location

Fork version of react-router-last-location but for react-router v6

• Provides access to the last location in react + react-router (v6.x) applications.
• Hooks, useLastLocation.
• HoC, withLastLocation.
• Handle redirects.
• TypeScript
• Useful for handling internal routing.
• Easily keep your users inside your app.

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 = /

Installation

# npm
npm install react react-router-dom history react-router-dom-last-location --save
# yarn
yarn add react react-router-dom history react-router-dom-last-location

Declare <LastLocationProvider /> inside <Router />.

index.js

// layout/Main.jsx
import { Outlet } from "react-router";
import { LastLocationProvider } from "react-router-dom-last-location";

export function MainLayout() {

  return (
    <>
      <LastLocationProvider>
        <Outlet />
      </LastLocationProvider>
    </>
  )
}

// App.jsx
import { Route, Routes } from "react-router";
import { BrowserRouter } from "react-router-dom";
import { LoggerLayout } from "./layout/Logger";
import { MainLayout } from "./layout/Main";
import { About } from "./pages/About";
import { Foo } from "./pages/Foo";
import { Home } from "./pages/Home";

function App() {
  return (
    <BrowserRouter >
      <Routes>
        <Route element={<MainLayout />}>
          <Route element={<LoggerLayout />}>
            <Route path="/" element={<Home />} />
            <Route path="/about" element={<About />} />
            <Route path="/foo" element={<Foo />} />
          </Route>
        </Route>
      </Routes>
    </BrowserRouter>
  );
}

export default App;

Use hook useLastLocation to get lastLocation.

// layout/Logger.jsx
import { Outlet, useLocation } from "react-router";
import { useLastLocation } from "react-router-dom-last-location";

export function LoggerLayout() {
  const location = useLocation()
  const lastLocation = useLastLocation();

  return (
    <>
      <Outlet />
      <div>
        <h3> Last Location state</h3>
        <pre>{JSON.stringify(lastLocation)}</pre>
      </div>

      <div>
        <h3> Current Location state</h3>
        <pre>{JSON.stringify(location)}</pre>
      </div>
    </>
  )
}

Use HoC withLastLocation to get lastLocation.

// layout/HocLogger.jsx
import { Outlet, useLocation } from "react-router";
import { withLastLocation } from "react-router-dom-last-location";

export const HocLoggerLayout = withLastLocation( ({lastLocation}) => {
  const location = useLocation()

  return (
    <>
      <Outlet />
      <div>
        <h3> Last Location state</h3>
        <pre>{JSON.stringify(lastLocation)}</pre>
      </div>

      <div>
        <h3> Current Location state</h3>
        <pre>{JSON.stringify(location)}</pre>
      </div>
    </>
  )
})

Use RedirectWithoutLastLocation to not store redirects as last location

import { RedirectWithoutLastLocation } from 'react-router-dom-last-location';
const MyPage = () => (
  <RedirectWithoutLastLocation to="/" />
);
export default MyPage;

You can still use a regular <Navigate to="/" replace /> component from react-router.

If you do, you'll then you need to manually pass the state: { preventLastLocation: true }, like below:

import { Navigate } from 'react-router-dom';
const MyPage = () => (
  <Navigate
    to="/"
    state={{ preventLastLocation: true }}
    replace
  />
);
export default MyPage;

LastLocationProvider

Props

watchOnlyPathname, type: boolean, default: false

Stores the last route only when pathname has changed.