use-back
v1.0.1 react react-router router back hook
Description
A native ESModule React hook for navigating back one location using React Router DOM, defaulting to navigating home instead of leaving your web application.
Installation
npm install use-back
Note: This package is a native ESModule that requires React Router DOM v6 as a peer dependency.
Usage
import {useBack} from "use-back";
const BackButton = () => {
const {hasBack, handleBack} = useBack();
return (
<button type="button" onClick={handleBack}>
{hasBack ? "Go Back" : "Go Home"}
</button>
);
};
useBack([defaultPath])
Returns: {handleBack, hasBack}
Object containing an event handler that navigates back, and a boolean that indicates whether the handler will navigate back or to the default path
Parameter | Type | Default | Description |
---|---|---|---|
defaultPath | string |
"/" |
Fallback path to navigate to for when there is not a previous history entry |
License
Copyright Evelyn Hathaway, MIT License
npm i use-back
Metadata
- MIT
- ^12.20.0 || ^14.13.1 || >=16.0.0
- Evelyn Hathaway
- released 8/21/2022