react-router-prompt
Advanced tools
Readme
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
The npm package react-router-prompt receives a total of 11,817 weekly downloads. As such, react-router-prompt popularity was classified as popular.
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 1 open source maintainer 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
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.