docs(history): clarify blockerFn boolean contract #5414
Open
Christopher96u(GitHub profile, opens in a new tab)wants to merge 1 commit into
main fromrefs/pull/5414/head·opened Fixes #3876
Summary by CodeRabbit#
- Documentation
- Clarified blocker semantics: returning true blocks navigation; false allows it, improving understanding for React usage.
- Refactor
- Introduced a clearer public type for navigation blocking and deprecated the previous allow-based alias. This is non-breaking and preserves existing behavior.
- Chores
- Added inline comments to clarify that a truthy blocker response prevents navigation in both history creation paths.
- 1
github-actions[bot](GitHub profile, opens in a new tab) added labelsdocumentation
github-actions[bot](GitHub profile, opens in a new tab) added labelspackage: history
View your CI Pipeline Execution ↗ for commit 7c2f75b4cd9268558b69715ca13854aadb7920f4
Command Status Duration Result nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded 6m 36s View ↗ nx run-many --target=build --exclude=examples/*...✅ Succeeded 1m 24s View ↗
☁️ Nx Cloud last updated this comment at
2025-10-09 06:12:57UTCMore templates
- tanstack-router-solid-example-basic
- tanstack-router-solid-example-basic-devtools-panel
- tanstack-router-solid-example-basic-file-based
- tanstack-router-solid-example-basic-non-nested-devtools
- tanstack-router-solid-example-basic-solid-query
- tanstack-router-solid-example-basic-solid-query-file-based
- tanstack-router-solid-example-basic-ssr-streaming-file-based
- tanstack-router-solid-example-kitchen-sink-file-based
- tanstack-router-solid-example-quickstart-file-based
- tanstack-solid-start-example-bare
- tanstack-solid-start-example-basic
- tanstack-solid-start-example-basic-static
- tanstack-router-react-example-authenticated-routes
- tanstack-router-react-example-authenticated-routes-firebase
- tanstack-router-react-example-basic
- tanstack-router-react-example-basic-default-search-params
- tanstack-router-react-example-basic-devtools-panel
- tanstack-router-react-example-basic-file-based
- tanstack-router-react-example-basic-non-nested-devtools
- tanstack-router-react-example-react-query
- tanstack-router-react-example-basic-react-query-file-based
- tanstack-router-react-example-basic-ssr-file-based
- tanstack-router-react-example-basic-ssr-streaming-file-based
- tanstack-router-react-example-basic-virtual-file-based
- tanstack-router-react-example-basic-virtual-inside-file-based
- tanstack-router-react-example-deferred-data
- tanstack-router-i18n-paraglide
- tanstack-router-react-example-kitchen-sink
- tanstack-router-react-example-kitchen-sink-file-based
- tanstack-router-react-example-kitchen-sink-react-query
- tanstack-router-react-example-kitchen-sink-react-query-file-based
- tanstack-router-react-example-large-file-based
- tanstack-router-react-example-location-masking
- tanstack-router-react-example-navigation-blocking
- tanstack-router-react-example-quickstart
- tanstack-router-react-example-quickstart-esbuild-file-based
- tanstack-router-react-example-quickstart-file-based
- tanstack-router-react-example-quickstart-rspack-file-based
- tanstack-router-react-example-quickstart-webpack-file-based
- router-monorepo-react-query
- router-mono-simple
- router-mono-simple-lazy
- tanstack-router-react-example-scroll-restoration
- tanstack-search-validator-adapters
- tanstack-start-example-bare
- tanstack-start-example-basic
- tanstack-start-example-basic-auth
- tanstack-start-example-basic-cloudflare
- tanstack-start-example-basic-react-query
- tanstack-start-example-basic-static
- tanstack-start-bun-hosting
- tanstack-start-example-convex-trellaux
- tanstack-start-example-counter
- tanstack-start-i18n-paraglide
- tanstack-start-example-large
- tanstack-start-example-material-ui
- tanstack-start-streaming-data-from-server-functions
- tanstack-start-example-supabase-basic
- tanstack-start-tailwind-v4
- tanstack-start-example-trellaux
- tanstack-start-example-workos
- tanstack-router-react-example-view-transitions
- tanstack-router-react-example-with-framer-motion
- tanstack-router-react-example-with-trpc
- tanstack-router-react-example-with-trpc-react-query
@tanstack/arktype-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5414@tanstack/directive-functions-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5414@tanstack/eslint-plugin-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5414@tanstack/history
npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5414@tanstack/nitro-v2-vite-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5414@tanstack/react-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5414@tanstack/react-router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5414@tanstack/react-router-ssr-query
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5414@tanstack/react-start
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5414@tanstack/react-start-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5414@tanstack/react-start-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5414@tanstack/router-cli
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5414@tanstack/router-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5414@tanstack/router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5414@tanstack/router-devtools-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5414@tanstack/router-generator
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5414@tanstack/router-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5414@tanstack/router-ssr-query-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5414@tanstack/router-utils
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5414@tanstack/router-vite-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5414@tanstack/server-functions-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5414@tanstack/solid-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5414@tanstack/solid-router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5414@tanstack/solid-start
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5414@tanstack/solid-start-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5414@tanstack/solid-start-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5414@tanstack/start-client-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5414@tanstack/start-plugin-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5414@tanstack/start-server-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5414@tanstack/start-static-server-functions
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5414@tanstack/start-storage-context
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5414@tanstack/valibot-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5414@tanstack/virtual-file-routes
npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5414@tanstack/zod-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5414commit:
7c2f75bThis clarification is still relevant. Could you rebase the PR and move the documentation change to
docs/router/api/router/useBlockerHook.md? TheShouldBlockNavigationrename and compatibility alias still match the current blocker behaviour, I believeChristopher96u(GitHub profile, opens in a new tab) linked this to fix #3876
Sign in to join this conversation.
Walkthrough#
Clarifies navigation blocker semantics: documentation now states that returning true blocks navigation and false allows it. In code, introduces ShouldBlockNavigation type, deprecates ShouldAllowNavigation as an alias, and updates BlockerFn to return boolean|Promise representing “should block” without changing runtime behavior.
Changes#
docs/router/framework/react/api/router/useBlockerHook.mdpackages/history/src/index.tsShouldBlockNavigationtype; deprecatedShouldAllowNavigationas alias; updatedBlockerFnreturn type to use block semantics; added inline comments clarifying truthy means “block” across history creation paths.Estimated code review effort#
🎯 2 (Simple) | ⏱️ ~10 minutes
Poem#
Pre-merge checks and finishing touches#
❌ Failed checks (1 warning)
@coderabbitai generate docstringsto improve docstring coverage.✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 30970808c5e472d8b91f058f6c382cc129e1b380 and 7c2f75b4cd9268558b69715ca13854aadb7920f4.
📒 Files selected for processing (2)
docs/router/framework/react/api/router/useBlockerHook.md(1 hunks)packages/history/src/index.ts(4 hunks)🧰 Additional context used
📓 Path-based instructions (3)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Files:
docs/router/framework/react/api/router/useBlockerHook.mddocs/{router,start}/**
📄 CodeRabbit inference engine (AGENTS.md)
Files:
docs/router/framework/react/api/router/useBlockerHook.md**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
Files:
packages/history/src/index.ts⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (5)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
❤️ Share