docs: add useBlocker hook design document #36
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Design for a new useBlocker hook that prevents navigation away from the current route. Key design decisions: - Synchronous boolean-returning function (aligns with beforeunload) - Returns BlockerState with proceed/reset for user confirmation UI - Integrates with both SPA navigations and beforeunload events - Multiple blockers can coexist in the component tree
Remove BlockerState return value and proceed/reset functions. The hook is now purely declarative - when shouldBlock returns true, navigation is prevented. To allow navigation, the blocking condition must change (e.g., save form to set isDirty to false). This aligns perfectly with beforeunload behavior where there's no programmatic way to proceed - only the browser's native dialog.
Simplify API from function to declarative boolean option:
- Before: useBlocker(() => isDirty)
- After: useBlocker({ enabled: isDirty })
This is more declarative and the object form allows for future
extension if needed.
Revert to () => boolean function so users can call confirm() inside the handler with their own custom message. Remove automatic beforeunload integration - that's a separate concern and users can add their own listener if needed. This keeps the hook focused on SPA navigation only.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Design for a new useBlocker hook that prevents navigation away from
the current route. Key design decisions: