react-router-prompt
Advanced tools
A component for the react-router 6
Prompt. Allows to create more flexible dialogs.
React-router-dom >= 6.19 and can be used only with data routers
pnpm add react-router-prompt
or with other package manager like yarn
yarn add react-router-prompt
<ReactRouterPrompt when={isDirty}>
{({ isActive, onConfirm, onCancel }) => (
<Modal show={isActive}>
<div>
<p>Do you really want to leave?</p>
<button onClick={onCancel}>Cancel</button>
<button onClick={onConfirm}>Ok</button>
</div>
</Modal>
)}
</ReactRouterPrompt>
when: boolean | BlockerFunction
BlockerFunction = (args: {
currentLocation: Location
nextLocation: Location
historyAction: HistoryAction
}) => boolean
beforeConfirm() : Promise<unknown> (Optional)
beforeCancel() : Promise<unknown> (Optional)
isActive: BooleanonConfirm(): voidonCancel(): voidThis version works with react-router-dom >=v6.19 Should be used within data routers
For react-router support (v6 - v6.2.x) please install v0.3.0
For react-router support (v6.7.x - v6.18.x) please install v0.5.4
Skipped support in middle due to breaking changes on react-router apis
Contributions, issues and feature requests are always welcome! Feel free to check issues page.
Give a ⭐️ if this project helped you!
Copyright © 2023 Shyam Gupta (shyamm@outlook.com) This project is MIT licensed.
FAQs
React Router Navigation Prompt for v6
We found that react-router-prompt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.