react-router 7.16.0 → 8.0.0-pre.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +0 -1
- package/dist/development/dom-export.d.ts +6 -172
- package/dist/development/dom-export.js +12 -1007
- package/dist/development/index-react-server-client.d.ts +7 -4
- package/dist/development/index-react-server-client.js +8 -52
- package/dist/development/index-react-server.d.ts +1645 -1635
- package/dist/development/index-react-server.js +2880 -3642
- package/dist/development/index.d.ts +43 -1475
- package/dist/development/index.js +37 -2621
- package/dist/development/lib/actions.js +62 -0
- package/dist/development/lib/components.d.ts +1022 -0
- package/dist/development/lib/components.js +835 -0
- package/dist/development/lib/context.d.ts +83 -0
- package/dist/development/lib/context.js +41 -0
- package/dist/development/lib/dom/dom.d.ts +119 -0
- package/dist/development/lib/dom/dom.js +143 -0
- package/dist/development/lib/dom/lib.d.ts +2042 -0
- package/dist/development/lib/dom/lib.js +1259 -0
- package/dist/development/lib/dom/server.d.ts +138 -0
- package/dist/development/lib/dom/server.js +301 -0
- package/dist/development/lib/dom/ssr/components.d.ts +196 -0
- package/dist/development/lib/dom/ssr/components.js +579 -0
- package/dist/development/lib/dom/ssr/data.js +29 -0
- package/dist/development/lib/dom/ssr/entry.d.ts +59 -0
- package/dist/development/lib/dom/ssr/errorBoundaries.d.ts +27 -0
- package/dist/development/lib/dom/ssr/errorBoundaries.js +83 -0
- package/dist/development/lib/dom/ssr/errors.d.ts +7 -0
- package/dist/development/lib/dom/ssr/errors.js +36 -0
- package/dist/development/lib/dom/ssr/fallback.js +28 -0
- package/dist/development/lib/dom/ssr/fog-of-war.d.ts +12 -0
- package/dist/development/lib/dom/ssr/fog-of-war.js +170 -0
- package/dist/development/lib/dom/ssr/hydration.d.ts +32 -0
- package/dist/development/lib/dom/ssr/hydration.js +29 -0
- package/dist/development/lib/dom/ssr/invariant.js +16 -0
- package/dist/development/lib/dom/ssr/links.js +170 -0
- package/dist/development/lib/dom/ssr/markup.js +24 -0
- package/dist/development/lib/dom/ssr/routeModules.d.ts +206 -0
- package/dist/development/lib/dom/ssr/routeModules.js +31 -0
- package/dist/development/lib/dom/ssr/routes-test-stub.d.ts +62 -0
- package/dist/development/lib/dom/ssr/routes-test-stub.js +108 -0
- package/dist/development/lib/dom/ssr/routes.d.ts +33 -0
- package/dist/development/lib/dom/ssr/routes.js +303 -0
- package/dist/development/lib/dom/ssr/server.d.ts +45 -0
- package/dist/development/lib/dom/ssr/server.js +68 -0
- package/dist/development/lib/dom/ssr/single-fetch.d.ts +14 -0
- package/dist/development/lib/dom/ssr/single-fetch.js +346 -0
- package/dist/development/lib/dom-export/dom-router-provider.d.ts +9 -0
- package/dist/development/lib/dom-export/dom-router-provider.js +22 -0
- package/dist/development/lib/dom-export/hydrated-router.d.ts +125 -0
- package/dist/development/lib/dom-export/hydrated-router.js +153 -0
- package/dist/development/lib/errors.js +29 -0
- package/dist/development/lib/hooks.d.ts +947 -0
- package/dist/development/lib/hooks.js +1386 -0
- package/dist/development/lib/href.d.ts +20 -0
- package/dist/development/lib/href.js +50 -0
- package/dist/development/lib/router/history.d.ts +258 -0
- package/dist/development/lib/router/history.js +371 -0
- package/dist/development/lib/router/instrumentation.d.ts +86 -0
- package/dist/development/lib/router/instrumentation.js +213 -0
- package/dist/development/lib/router/links.d.ts +113 -0
- package/dist/development/lib/router/router.d.ts +663 -0
- package/dist/development/lib/router/router.js +2981 -0
- package/dist/development/lib/router/utils.d.ts +942 -0
- package/dist/development/lib/router/utils.js +791 -0
- package/dist/development/lib/rsc/browser.d.ts +137 -0
- package/dist/development/lib/rsc/browser.js +599 -0
- package/dist/development/lib/rsc/errorBoundaries.d.ts +11 -0
- package/dist/development/lib/rsc/errorBoundaries.js +90 -0
- package/dist/development/lib/rsc/html-stream/browser.d.ts +48 -0
- package/dist/development/lib/rsc/html-stream/browser.js +74 -0
- package/dist/development/lib/rsc/html-stream/server.js +78 -0
- package/dist/development/lib/rsc/route-modules.js +27 -0
- package/dist/development/lib/rsc/server.rsc.d.ts +219 -0
- package/dist/development/lib/rsc/server.ssr.d.ts +129 -0
- package/dist/development/lib/rsc/server.ssr.js +388 -0
- package/dist/development/lib/server-runtime/build.d.ts +66 -0
- package/dist/development/lib/server-runtime/cookies.d.ts +66 -0
- package/dist/development/lib/server-runtime/cookies.js +139 -0
- package/dist/development/lib/server-runtime/crypto.js +43 -0
- package/dist/development/lib/server-runtime/data.d.ts +13 -0
- package/dist/development/lib/server-runtime/data.js +25 -0
- package/dist/development/lib/server-runtime/dev.d.ts +9 -0
- package/dist/development/lib/server-runtime/dev.js +26 -0
- package/dist/development/lib/server-runtime/entry.js +20 -0
- package/dist/development/lib/server-runtime/errors.js +95 -0
- package/dist/development/lib/server-runtime/headers.js +73 -0
- package/dist/development/lib/server-runtime/invariant.js +19 -0
- package/dist/development/lib/server-runtime/mode.d.ts +12 -0
- package/dist/development/lib/server-runtime/mode.js +25 -0
- package/dist/development/lib/server-runtime/routeMatching.js +28 -0
- package/dist/development/lib/server-runtime/routes.d.ts +13 -0
- package/dist/development/lib/server-runtime/routes.js +74 -0
- package/dist/development/lib/server-runtime/server.d.ts +10 -0
- package/dist/development/lib/server-runtime/server.js +351 -0
- package/dist/development/lib/server-runtime/serverHandoff.js +17 -0
- package/dist/development/lib/server-runtime/sessions/cookieStorage.d.ts +25 -0
- package/dist/development/lib/server-runtime/sessions/cookieStorage.js +45 -0
- package/dist/development/lib/server-runtime/sessions/memoryStorage.d.ts +23 -0
- package/dist/development/lib/server-runtime/sessions/memoryStorage.js +52 -0
- package/dist/development/lib/server-runtime/sessions.d.ts +145 -0
- package/dist/development/lib/server-runtime/sessions.js +98 -0
- package/dist/development/lib/server-runtime/single-fetch.d.ts +7 -0
- package/dist/development/lib/server-runtime/single-fetch.js +215 -0
- package/dist/development/lib/server-runtime/urls.js +31 -0
- package/dist/development/lib/server-runtime/warnings.js +20 -0
- package/dist/development/lib/types/future.d.ts +9 -0
- package/dist/development/lib/types/internal.d.ts +26 -177
- package/dist/development/lib/types/internal.js +3 -2
- package/dist/{production/register-CNAx3TXj.d.ts → development/lib/types/register.d.ts} +9 -15
- package/dist/development/lib/types/route-data.d.ts +113 -0
- package/dist/development/lib/types/route-module-annotations.d.ts +149 -0
- package/dist/development/lib/types/route-module.d.ts +19 -0
- package/dist/development/lib/types/serializes-to.d.ts +13 -0
- package/dist/development/lib/types/utils.d.ts +11 -0
- package/dist/development/vendor/turbo-stream-v2/flatten.js +159 -0
- package/dist/development/vendor/turbo-stream-v2/turbo-stream.js +178 -0
- package/dist/development/vendor/turbo-stream-v2/unflatten.js +198 -0
- package/dist/development/vendor/turbo-stream-v2/utils.js +47 -0
- package/dist/production/dom-export.d.ts +6 -172
- package/dist/production/dom-export.js +12 -1007
- package/dist/production/index-react-server-client.d.ts +7 -4
- package/dist/production/index-react-server-client.js +8 -52
- package/dist/production/index-react-server.d.ts +1645 -1635
- package/dist/production/index-react-server.js +2871 -3642
- package/dist/production/index.d.ts +43 -1475
- package/dist/production/index.js +37 -2621
- package/dist/production/lib/actions.js +62 -0
- package/dist/production/lib/components.d.ts +1022 -0
- package/dist/production/lib/components.js +835 -0
- package/dist/production/lib/context.d.ts +83 -0
- package/dist/production/lib/context.js +41 -0
- package/dist/production/lib/dom/dom.d.ts +119 -0
- package/dist/production/lib/dom/dom.js +143 -0
- package/dist/production/lib/dom/lib.d.ts +2042 -0
- package/dist/production/lib/dom/lib.js +1259 -0
- package/dist/production/lib/dom/server.d.ts +138 -0
- package/dist/production/lib/dom/server.js +301 -0
- package/dist/production/lib/dom/ssr/components.d.ts +196 -0
- package/dist/production/lib/dom/ssr/components.js +579 -0
- package/dist/production/lib/dom/ssr/data.js +29 -0
- package/dist/production/lib/dom/ssr/entry.d.ts +59 -0
- package/dist/production/lib/dom/ssr/errorBoundaries.d.ts +27 -0
- package/dist/production/lib/dom/ssr/errorBoundaries.js +83 -0
- package/dist/production/lib/dom/ssr/errors.d.ts +7 -0
- package/dist/production/lib/dom/ssr/errors.js +36 -0
- package/dist/production/lib/dom/ssr/fallback.js +21 -0
- package/dist/production/lib/dom/ssr/fog-of-war.d.ts +12 -0
- package/dist/production/lib/dom/ssr/fog-of-war.js +170 -0
- package/dist/production/lib/dom/ssr/hydration.d.ts +32 -0
- package/dist/production/lib/dom/ssr/hydration.js +29 -0
- package/dist/production/lib/dom/ssr/invariant.js +16 -0
- package/dist/production/lib/dom/ssr/links.js +170 -0
- package/dist/production/lib/dom/ssr/markup.js +24 -0
- package/dist/production/lib/dom/ssr/routeModules.d.ts +206 -0
- package/dist/production/lib/dom/ssr/routeModules.js +31 -0
- package/dist/production/lib/dom/ssr/routes-test-stub.d.ts +62 -0
- package/dist/production/lib/dom/ssr/routes-test-stub.js +108 -0
- package/dist/production/lib/dom/ssr/routes.d.ts +33 -0
- package/dist/production/lib/dom/ssr/routes.js +303 -0
- package/dist/production/lib/dom/ssr/server.d.ts +45 -0
- package/dist/production/lib/dom/ssr/server.js +68 -0
- package/dist/production/lib/dom/ssr/single-fetch.d.ts +14 -0
- package/dist/production/lib/dom/ssr/single-fetch.js +346 -0
- package/dist/production/lib/dom-export/dom-router-provider.d.ts +9 -0
- package/dist/production/lib/dom-export/dom-router-provider.js +22 -0
- package/dist/production/lib/dom-export/hydrated-router.d.ts +125 -0
- package/dist/production/lib/dom-export/hydrated-router.js +153 -0
- package/dist/production/lib/errors.js +29 -0
- package/dist/production/lib/hooks.d.ts +947 -0
- package/dist/production/lib/hooks.js +1371 -0
- package/dist/production/lib/href.d.ts +20 -0
- package/dist/production/lib/href.js +50 -0
- package/dist/production/lib/router/history.d.ts +258 -0
- package/dist/production/lib/router/history.js +371 -0
- package/dist/production/lib/router/instrumentation.d.ts +86 -0
- package/dist/production/lib/router/instrumentation.js +213 -0
- package/dist/production/lib/router/links.d.ts +113 -0
- package/dist/production/lib/router/router.d.ts +663 -0
- package/dist/production/lib/router/router.js +2981 -0
- package/dist/production/lib/router/utils.d.ts +942 -0
- package/dist/production/lib/router/utils.js +782 -0
- package/dist/production/lib/rsc/browser.d.ts +137 -0
- package/dist/production/lib/rsc/browser.js +599 -0
- package/dist/production/lib/rsc/errorBoundaries.d.ts +11 -0
- package/dist/production/lib/rsc/errorBoundaries.js +90 -0
- package/dist/production/lib/rsc/html-stream/browser.d.ts +48 -0
- package/dist/production/lib/rsc/html-stream/browser.js +74 -0
- package/dist/production/lib/rsc/html-stream/server.js +78 -0
- package/dist/production/lib/rsc/route-modules.js +27 -0
- package/dist/production/lib/rsc/server.rsc.d.ts +219 -0
- package/dist/production/lib/rsc/server.ssr.d.ts +129 -0
- package/dist/production/lib/rsc/server.ssr.js +388 -0
- package/dist/production/lib/server-runtime/build.d.ts +66 -0
- package/dist/production/lib/server-runtime/cookies.d.ts +66 -0
- package/dist/production/lib/server-runtime/cookies.js +139 -0
- package/dist/production/lib/server-runtime/crypto.js +43 -0
- package/dist/production/lib/server-runtime/data.d.ts +13 -0
- package/dist/production/lib/server-runtime/data.js +25 -0
- package/dist/production/lib/server-runtime/dev.d.ts +9 -0
- package/dist/production/lib/server-runtime/dev.js +26 -0
- package/dist/production/lib/server-runtime/entry.js +20 -0
- package/dist/production/lib/server-runtime/errors.js +95 -0
- package/dist/production/lib/server-runtime/headers.js +73 -0
- package/dist/production/lib/server-runtime/invariant.js +19 -0
- package/dist/production/lib/server-runtime/mode.d.ts +12 -0
- package/dist/production/lib/server-runtime/mode.js +25 -0
- package/dist/production/lib/server-runtime/routeMatching.js +28 -0
- package/dist/production/lib/server-runtime/routes.d.ts +13 -0
- package/dist/production/lib/server-runtime/routes.js +74 -0
- package/dist/production/lib/server-runtime/server.d.ts +10 -0
- package/dist/production/lib/server-runtime/server.js +351 -0
- package/dist/production/lib/server-runtime/serverHandoff.js +17 -0
- package/dist/production/lib/server-runtime/sessions/cookieStorage.d.ts +25 -0
- package/dist/production/lib/server-runtime/sessions/cookieStorage.js +45 -0
- package/dist/production/lib/server-runtime/sessions/memoryStorage.d.ts +23 -0
- package/dist/production/lib/server-runtime/sessions/memoryStorage.js +52 -0
- package/dist/production/lib/server-runtime/sessions.d.ts +145 -0
- package/dist/production/lib/server-runtime/sessions.js +98 -0
- package/dist/production/lib/server-runtime/single-fetch.d.ts +7 -0
- package/dist/production/lib/server-runtime/single-fetch.js +215 -0
- package/dist/production/lib/server-runtime/urls.js +31 -0
- package/dist/production/lib/server-runtime/warnings.js +20 -0
- package/dist/production/lib/types/future.d.ts +9 -0
- package/dist/production/lib/types/internal.d.ts +26 -177
- package/dist/production/lib/types/internal.js +3 -2
- package/dist/{development/register-CNAx3TXj.d.ts → production/lib/types/register.d.ts} +9 -15
- package/dist/production/lib/types/route-data.d.ts +113 -0
- package/dist/production/lib/types/route-module-annotations.d.ts +149 -0
- package/dist/production/lib/types/route-module.d.ts +19 -0
- package/dist/production/lib/types/serializes-to.d.ts +13 -0
- package/dist/production/lib/types/utils.d.ts +11 -0
- package/dist/production/vendor/turbo-stream-v2/flatten.js +159 -0
- package/dist/production/vendor/turbo-stream-v2/turbo-stream.js +178 -0
- package/dist/production/vendor/turbo-stream-v2/unflatten.js +198 -0
- package/dist/production/vendor/turbo-stream-v2/utils.js +47 -0
- package/docs/explanation/backend-for-frontend.md +50 -0
- package/docs/explanation/code-splitting.md +77 -0
- package/docs/explanation/concurrency.md +135 -0
- package/docs/explanation/form-vs-fetcher.md +292 -0
- package/docs/explanation/hot-module-replacement.md +137 -0
- package/docs/explanation/hydration.md +14 -0
- package/docs/explanation/index-query-param.md +86 -0
- package/docs/explanation/index.md +4 -0
- package/docs/explanation/lazy-route-discovery.md +78 -0
- package/docs/explanation/location.md +6 -0
- package/docs/explanation/progressive-enhancement.md +150 -0
- package/docs/explanation/race-conditions.md +88 -0
- package/docs/explanation/react-transitions.md +160 -0
- package/docs/explanation/route-matching.md +7 -0
- package/docs/explanation/server-client-execution.md +4 -0
- package/docs/explanation/sessions-and-cookies.md +465 -0
- package/docs/explanation/special-files.md +16 -0
- package/docs/explanation/state-management.md +524 -0
- package/docs/explanation/styling.md +87 -0
- package/docs/explanation/type-safety.md +82 -0
- package/docs/how-to/accessibility.md +44 -0
- package/docs/how-to/client-data.md +199 -0
- package/docs/how-to/data-strategy.md +317 -0
- package/docs/how-to/error-boundary.md +231 -0
- package/docs/how-to/error-reporting.md +134 -0
- package/docs/how-to/fetchers.md +307 -0
- package/docs/how-to/file-route-conventions.md +410 -0
- package/docs/how-to/file-uploads.md +217 -0
- package/docs/how-to/form-validation.md +120 -0
- package/docs/how-to/headers.md +164 -0
- package/docs/how-to/index.md +4 -0
- package/docs/how-to/instrumentation.md +556 -0
- package/docs/how-to/meta.md +40 -0
- package/docs/how-to/middleware.md +728 -0
- package/docs/how-to/navigation-blocking.md +233 -0
- package/docs/how-to/optimize-revalidation.md +12 -0
- package/docs/how-to/pre-rendering.md +225 -0
- package/docs/how-to/presets.md +103 -0
- package/docs/how-to/react-server-components.md +899 -0
- package/docs/how-to/resource-routes.md +126 -0
- package/docs/how-to/route-module-type-safety.md +100 -0
- package/docs/how-to/search-params.md +4 -0
- package/docs/how-to/security.md +30 -0
- package/docs/how-to/server-bundles.md +66 -0
- package/docs/how-to/spa.md +120 -0
- package/docs/how-to/status.md +63 -0
- package/docs/how-to/suspense.md +132 -0
- package/docs/how-to/using-handle.md +117 -0
- package/docs/how-to/view-transitions.md +237 -0
- package/docs/how-to/webhook.md +50 -0
- package/docs/index.md +39 -0
- package/docs/start/data/actions.md +138 -0
- package/docs/start/data/custom.md +198 -0
- package/docs/start/data/data-loading.md +44 -0
- package/docs/start/data/index.md +4 -0
- package/docs/start/data/installation.md +52 -0
- package/docs/start/data/navigating.md +12 -0
- package/docs/start/data/pending-ui.md +12 -0
- package/docs/start/data/route-object.md +248 -0
- package/docs/start/data/routing.md +281 -0
- package/docs/start/data/testing.md +8 -0
- package/docs/start/declarative/index.md +4 -0
- package/docs/start/declarative/installation.md +43 -0
- package/docs/start/declarative/navigating.md +133 -0
- package/docs/start/declarative/routing.md +237 -0
- package/docs/start/declarative/url-values.md +65 -0
- package/docs/start/framework/actions.md +175 -0
- package/docs/start/framework/data-loading.md +201 -0
- package/docs/start/framework/deploying.md +96 -0
- package/docs/start/framework/index.md +4 -0
- package/docs/start/framework/installation.md +42 -0
- package/docs/start/framework/navigating.md +182 -0
- package/docs/start/framework/pending-ui.md +142 -0
- package/docs/start/framework/rendering.md +59 -0
- package/docs/start/framework/route-module.md +527 -0
- package/docs/start/framework/routing.md +362 -0
- package/docs/start/framework/testing.md +133 -0
- package/docs/start/index.md +4 -0
- package/docs/start/modes.md +201 -0
- package/docs/upgrading/component-routes.md +363 -0
- package/docs/upgrading/future.md +31 -0
- package/docs/upgrading/index.md +4 -0
- package/docs/upgrading/remix.md +403 -0
- package/docs/upgrading/router-provider.md +442 -0
- package/docs/upgrading/v6.md +379 -0
- package/package.json +44 -87
- package/dist/development/browser-D3uq9sI1.d.ts +0 -318
- package/dist/development/browser-nIQ4Nsyi.d.mts +0 -318
- package/dist/development/chunk-IBI7OMNB.js +0 -1363
- package/dist/development/chunk-QUQL4437.mjs +0 -11529
- package/dist/development/chunk-S54KXAEJ.mjs +0 -2585
- package/dist/development/chunk-SRID2YZ2.js +0 -10229
- package/dist/development/chunk-XEJDWL2B.js +0 -188
- package/dist/development/context-m8rizgnE.d.mts +0 -1771
- package/dist/development/data-D4xhSy90.d.ts +0 -1732
- package/dist/development/data-U8FS-wNn.d.mts +0 -1732
- package/dist/development/dom-export.d.mts +0 -172
- package/dist/development/dom-export.mjs +0 -1008
- package/dist/development/index-react-server-client-BLiUx67a.d.ts +0 -3655
- package/dist/development/index-react-server-client-CdKROblb.d.mts +0 -2600
- package/dist/development/index-react-server-client.d.mts +0 -4
- package/dist/development/index-react-server-client.mjs +0 -59
- package/dist/development/index-react-server.d.mts +0 -2703
- package/dist/development/index-react-server.mjs +0 -3780
- package/dist/development/index.d.mts +0 -1478
- package/dist/development/index.mjs +0 -277
- package/dist/development/instrumentation-1q4YhLGP.d.ts +0 -715
- package/dist/development/lib/types/internal.d.mts +0 -184
- package/dist/development/lib/types/internal.mjs +0 -10
- package/dist/development/register-CqK96Zfk.d.mts +0 -30
- package/dist/production/browser-D3uq9sI1.d.ts +0 -318
- package/dist/production/browser-nIQ4Nsyi.d.mts +0 -318
- package/dist/production/chunk-EAQNHM3N.js +0 -188
- package/dist/production/chunk-NALGHHKE.mjs +0 -2585
- package/dist/production/chunk-Q65P7S7Y.mjs +0 -11529
- package/dist/production/chunk-SKEDDLRM.js +0 -1363
- package/dist/production/chunk-Y7DNFQZP.js +0 -10229
- package/dist/production/context-m8rizgnE.d.mts +0 -1771
- package/dist/production/data-D4xhSy90.d.ts +0 -1732
- package/dist/production/data-U8FS-wNn.d.mts +0 -1732
- package/dist/production/dom-export.d.mts +0 -172
- package/dist/production/dom-export.mjs +0 -1008
- package/dist/production/index-react-server-client-BLiUx67a.d.ts +0 -3655
- package/dist/production/index-react-server-client-CdKROblb.d.mts +0 -2600
- package/dist/production/index-react-server-client.d.mts +0 -4
- package/dist/production/index-react-server-client.mjs +0 -59
- package/dist/production/index-react-server.d.mts +0 -2703
- package/dist/production/index-react-server.mjs +0 -3780
- package/dist/production/index.d.mts +0 -1478
- package/dist/production/index.mjs +0 -277
- package/dist/production/instrumentation-1q4YhLGP.d.ts +0 -715
- package/dist/production/lib/types/internal.d.mts +0 -184
- package/dist/production/lib/types/internal.mjs +0 -10
- package/dist/production/register-CqK96Zfk.d.mts +0 -30
|
@@ -0,0 +1,1371 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* react-router v8.0.0-pre.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) Remix Software Inc.
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE.md file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
import { invariant, parsePath, warning } from "./router/history.js";
|
|
12
|
+
import { convertRouteMatchToUiMatch, decodePath, getResolveToMatches, getRoutePattern, isBrowser, isRouteErrorResponse, joinPaths, matchPath, matchRoutes, parseToInfo, resolveTo, stripBasename } from "./router/utils.js";
|
|
13
|
+
import { IDLE_BLOCKER } from "./router/router.js";
|
|
14
|
+
import { AwaitContext, DataRouterContext, DataRouterStateContext, LocationContext, NavigationContext, RSCRouterContext, RouteContext, RouteErrorContext } from "./context.js";
|
|
15
|
+
import { decodeRedirectErrorDigest, decodeRouteErrorResponseDigest } from "./errors.js";
|
|
16
|
+
import * as React$1 from "react";
|
|
17
|
+
//#region lib/hooks.tsx
|
|
18
|
+
/**
|
|
19
|
+
* Resolves a URL against the current {@link Location}.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* import { useHref } from "react-router";
|
|
23
|
+
*
|
|
24
|
+
* function SomeComponent() {
|
|
25
|
+
* let href = useHref("some/where");
|
|
26
|
+
* // "/resolved/some/where"
|
|
27
|
+
* }
|
|
28
|
+
*
|
|
29
|
+
* @public
|
|
30
|
+
* @category Hooks
|
|
31
|
+
* @param to The path to resolve
|
|
32
|
+
* @param options Options
|
|
33
|
+
* @param options.relative Defaults to `"route"` so routing is relative to the
|
|
34
|
+
* route tree.
|
|
35
|
+
* Set to `"path"` to make relative routing operate against path segments.
|
|
36
|
+
* @returns The resolved href string
|
|
37
|
+
*/
|
|
38
|
+
function useHref(to, { relative } = {}) {
|
|
39
|
+
invariant(useInRouterContext(), `useHref() may be used only in the context of a <Router> component.`);
|
|
40
|
+
let { basename, navigator } = React$1.useContext(NavigationContext);
|
|
41
|
+
let { hash, pathname, search } = useResolvedPath(to, { relative });
|
|
42
|
+
let joinedPathname = pathname;
|
|
43
|
+
if (basename !== "/") joinedPathname = pathname === "/" ? basename : joinPaths([basename, pathname]);
|
|
44
|
+
return navigator.createHref({
|
|
45
|
+
pathname: joinedPathname,
|
|
46
|
+
search,
|
|
47
|
+
hash
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Returns `true` if this component is a descendant of a {@link Router}, useful
|
|
52
|
+
* to ensure a component is used within a {@link Router}.
|
|
53
|
+
*
|
|
54
|
+
* @public
|
|
55
|
+
* @category Hooks
|
|
56
|
+
* @mode framework
|
|
57
|
+
* @mode data
|
|
58
|
+
* @returns Whether the component is within a {@link Router} context
|
|
59
|
+
*/
|
|
60
|
+
function useInRouterContext() {
|
|
61
|
+
return React$1.useContext(LocationContext) != null;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Returns the current {@link Location}. This can be useful if you'd like to
|
|
65
|
+
* perform some side effect whenever it changes.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* import * as React from 'react'
|
|
69
|
+
* import { useLocation } from 'react-router'
|
|
70
|
+
*
|
|
71
|
+
* function SomeComponent() {
|
|
72
|
+
* let location = useLocation()
|
|
73
|
+
*
|
|
74
|
+
* React.useEffect(() => {
|
|
75
|
+
* // Google Analytics
|
|
76
|
+
* ga('send', 'pageview')
|
|
77
|
+
* }, [location]);
|
|
78
|
+
*
|
|
79
|
+
* return (
|
|
80
|
+
* // ...
|
|
81
|
+
* );
|
|
82
|
+
* }
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
* @category Hooks
|
|
86
|
+
* @returns The current {@link Location} object
|
|
87
|
+
*/
|
|
88
|
+
function useLocation() {
|
|
89
|
+
invariant(useInRouterContext(), `useLocation() may be used only in the context of a <Router> component.`);
|
|
90
|
+
return React$1.useContext(LocationContext).location;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Returns the current {@link Navigation} action which describes how the router
|
|
94
|
+
* came to the current {@link Location}, either by a pop, push, or replace on
|
|
95
|
+
* the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History) stack.
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
* @category Hooks
|
|
99
|
+
* @returns The current {@link NavigationType} (`"POP"`, `"PUSH"`, or `"REPLACE"`)
|
|
100
|
+
*/
|
|
101
|
+
function useNavigationType() {
|
|
102
|
+
return React$1.useContext(LocationContext).navigationType;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Returns a {@link PathMatch} object if the given pattern matches the current URL.
|
|
106
|
+
* This is useful for components that need to know "active" state, e.g.
|
|
107
|
+
* {@link NavLink | `<NavLink>`}.
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
* @category Hooks
|
|
111
|
+
* @param pattern The pattern to match against the current {@link Location}
|
|
112
|
+
* @returns The path match object if the pattern matches, `null` otherwise
|
|
113
|
+
*/
|
|
114
|
+
function useMatch(pattern) {
|
|
115
|
+
invariant(useInRouterContext(), `useMatch() may be used only in the context of a <Router> component.`);
|
|
116
|
+
let { pathname } = useLocation();
|
|
117
|
+
return React$1.useMemo(() => matchPath(pattern, decodePath(pathname)), [pathname, pattern]);
|
|
118
|
+
}
|
|
119
|
+
const navigateEffectWarning = "You should call navigate() in a React.useEffect(), not when your component is first rendered.";
|
|
120
|
+
/**
|
|
121
|
+
* Returns a function that lets you navigate programmatically in the browser in
|
|
122
|
+
* response to user interactions or effects.
|
|
123
|
+
*
|
|
124
|
+
* It's often better to use {@link redirect} in [`action`](../../start/framework/route-module#action)/[`loader`](../../start/framework/route-module#loader)
|
|
125
|
+
* functions than this hook.
|
|
126
|
+
*
|
|
127
|
+
* The returned function signature is `navigate(to, options?)`/`navigate(delta)` where:
|
|
128
|
+
*
|
|
129
|
+
* * `to` can be a string path, a {@link To} object, or a number (delta)
|
|
130
|
+
* * `options` contains options for modifying the navigation
|
|
131
|
+
* * These options work in all modes (Framework, Data, and Declarative):
|
|
132
|
+
* * `relative`: `"route"` or `"path"` to control relative routing logic
|
|
133
|
+
* * `replace`: Replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History) stack
|
|
134
|
+
* * `state`: Optional [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state) to include with the new {@link Location}
|
|
135
|
+
* * These options only work in Framework and Data modes:
|
|
136
|
+
* * `flushSync`: Wrap the DOM updates in [`ReactDom.flushSync`](https://react.dev/reference/react-dom/flushSync)
|
|
137
|
+
* * `preventScrollReset`: Do not scroll back to the top of the page after navigation
|
|
138
|
+
* * `viewTransition`: Enable [`document.startViewTransition`](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for this navigation
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* import { useNavigate } from "react-router";
|
|
142
|
+
*
|
|
143
|
+
* function SomeComponent() {
|
|
144
|
+
* let navigate = useNavigate();
|
|
145
|
+
* return (
|
|
146
|
+
* <button onClick={() => navigate(-1)}>
|
|
147
|
+
* Go Back
|
|
148
|
+
* </button>
|
|
149
|
+
* );
|
|
150
|
+
* }
|
|
151
|
+
*
|
|
152
|
+
* @additionalExamples
|
|
153
|
+
* ### Navigate to another path
|
|
154
|
+
*
|
|
155
|
+
* ```tsx
|
|
156
|
+
* navigate("/some/route");
|
|
157
|
+
* navigate("/some/route?search=param");
|
|
158
|
+
* ```
|
|
159
|
+
*
|
|
160
|
+
* ### Navigate with a {@link To} object
|
|
161
|
+
*
|
|
162
|
+
* All properties are optional.
|
|
163
|
+
*
|
|
164
|
+
* ```tsx
|
|
165
|
+
* navigate({
|
|
166
|
+
* pathname: "/some/route",
|
|
167
|
+
* search: "?search=param",
|
|
168
|
+
* hash: "#hash",
|
|
169
|
+
* state: { some: "state" },
|
|
170
|
+
* });
|
|
171
|
+
* ```
|
|
172
|
+
*
|
|
173
|
+
* If you use `state`, that will be available on the {@link Location} object on
|
|
174
|
+
* the next page. Access it with `useLocation().state` (see {@link useLocation}).
|
|
175
|
+
*
|
|
176
|
+
* ### Navigate back or forward in the history stack
|
|
177
|
+
*
|
|
178
|
+
* ```tsx
|
|
179
|
+
* // back
|
|
180
|
+
* // often used to close modals
|
|
181
|
+
* navigate(-1);
|
|
182
|
+
*
|
|
183
|
+
* // forward
|
|
184
|
+
* // often used in a multistep wizard workflows
|
|
185
|
+
* navigate(1);
|
|
186
|
+
* ```
|
|
187
|
+
*
|
|
188
|
+
* Be cautious with `navigate(number)`. If your application can load up to a
|
|
189
|
+
* route that has a button that tries to navigate forward/back, there may not be
|
|
190
|
+
* a [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
|
|
191
|
+
* entry to go back or forward to, or it can go somewhere you don't expect
|
|
192
|
+
* (like a different domain).
|
|
193
|
+
*
|
|
194
|
+
* Only use this if you're sure they will have an entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
|
|
195
|
+
* stack to navigate to.
|
|
196
|
+
*
|
|
197
|
+
* ### Replace the current entry in the history stack
|
|
198
|
+
*
|
|
199
|
+
* This will remove the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
|
|
200
|
+
* stack, replacing it with a new one, similar to a server side redirect.
|
|
201
|
+
*
|
|
202
|
+
* ```tsx
|
|
203
|
+
* navigate("/some/route", { replace: true });
|
|
204
|
+
* ```
|
|
205
|
+
*
|
|
206
|
+
* ### Prevent Scroll Reset
|
|
207
|
+
*
|
|
208
|
+
* [MODES: framework, data]
|
|
209
|
+
*
|
|
210
|
+
* <br/>
|
|
211
|
+
* <br/>
|
|
212
|
+
*
|
|
213
|
+
* To prevent {@link ScrollRestoration | `<ScrollRestoration>`} from resetting
|
|
214
|
+
* the scroll position, use the `preventScrollReset` option.
|
|
215
|
+
*
|
|
216
|
+
* ```tsx
|
|
217
|
+
* navigate("?some-tab=1", { preventScrollReset: true });
|
|
218
|
+
* ```
|
|
219
|
+
*
|
|
220
|
+
* For example, if you have a tab interface connected to search params in the
|
|
221
|
+
* middle of a page, and you don't want it to scroll to the top when a tab is
|
|
222
|
+
* clicked.
|
|
223
|
+
*
|
|
224
|
+
* ### Return Type Augmentation
|
|
225
|
+
*
|
|
226
|
+
* Internally, `useNavigate` uses a separate implementation when you are in
|
|
227
|
+
* Declarative mode versus Data/Framework mode - the primary difference being
|
|
228
|
+
* that the latter is able to return a stable reference that does not change
|
|
229
|
+
* identity across navigations. The implementation in Data/Framework mode also
|
|
230
|
+
* returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
231
|
+
* that resolves when the navigation is completed. This means the return type of
|
|
232
|
+
* `useNavigate` is `void | Promise<void>`. This is accurate, but can lead to
|
|
233
|
+
* some red squigglies based on the union in the return value:
|
|
234
|
+
*
|
|
235
|
+
* - If you're using `typescript-eslint`, you may see errors from
|
|
236
|
+
* [`@typescript-eslint/no-floating-promises`](https://typescript-eslint.io/rules/no-floating-promises)
|
|
237
|
+
* - In Framework/Data mode, `React.use(navigate())` will show a false-positive
|
|
238
|
+
* `Argument of type 'void | Promise<void>' is not assignable to parameter of
|
|
239
|
+
* type 'Usable<void>'` error
|
|
240
|
+
*
|
|
241
|
+
* The easiest way to work around these issues is to augment the type based on the
|
|
242
|
+
* router you're using:
|
|
243
|
+
*
|
|
244
|
+
* ```ts
|
|
245
|
+
* // If using <BrowserRouter>
|
|
246
|
+
* declare module "react-router" {
|
|
247
|
+
* interface NavigateFunction {
|
|
248
|
+
* (to: To, options?: NavigateOptions): void;
|
|
249
|
+
* (delta: number): void;
|
|
250
|
+
* }
|
|
251
|
+
* }
|
|
252
|
+
*
|
|
253
|
+
* // If using <RouterProvider> or Framework mode
|
|
254
|
+
* declare module "react-router" {
|
|
255
|
+
* interface NavigateFunction {
|
|
256
|
+
* (to: To, options?: NavigateOptions): Promise<void>;
|
|
257
|
+
* (delta: number): Promise<void>;
|
|
258
|
+
* }
|
|
259
|
+
* }
|
|
260
|
+
* ```
|
|
261
|
+
*
|
|
262
|
+
* @public
|
|
263
|
+
* @category Hooks
|
|
264
|
+
* @returns A navigate function for programmatic navigation
|
|
265
|
+
*/
|
|
266
|
+
function useNavigate() {
|
|
267
|
+
let { isDataRoute } = React$1.useContext(RouteContext);
|
|
268
|
+
return isDataRoute ? useNavigateStable() : useNavigateUnstable();
|
|
269
|
+
}
|
|
270
|
+
function useNavigateUnstable() {
|
|
271
|
+
invariant(useInRouterContext(), `useNavigate() may be used only in the context of a <Router> component.`);
|
|
272
|
+
let dataRouterContext = React$1.useContext(DataRouterContext);
|
|
273
|
+
let { basename, navigator } = React$1.useContext(NavigationContext);
|
|
274
|
+
let { matches } = React$1.useContext(RouteContext);
|
|
275
|
+
let { pathname: locationPathname } = useLocation();
|
|
276
|
+
let routePathnamesJson = JSON.stringify(getResolveToMatches(matches));
|
|
277
|
+
let activeRef = React$1.useRef(false);
|
|
278
|
+
React$1.useLayoutEffect(() => {
|
|
279
|
+
activeRef.current = true;
|
|
280
|
+
});
|
|
281
|
+
return React$1.useCallback((to, options = {}) => {
|
|
282
|
+
warning(activeRef.current, navigateEffectWarning);
|
|
283
|
+
if (!activeRef.current) return;
|
|
284
|
+
if (typeof to === "number") {
|
|
285
|
+
navigator.go(to);
|
|
286
|
+
return;
|
|
287
|
+
}
|
|
288
|
+
let path = resolveTo(to, JSON.parse(routePathnamesJson), locationPathname, options.relative === "path");
|
|
289
|
+
if (dataRouterContext == null && basename !== "/") path.pathname = path.pathname === "/" ? basename : joinPaths([basename, path.pathname]);
|
|
290
|
+
(!!options.replace ? navigator.replace : navigator.push)(path, options.state, options);
|
|
291
|
+
}, [
|
|
292
|
+
basename,
|
|
293
|
+
navigator,
|
|
294
|
+
routePathnamesJson,
|
|
295
|
+
locationPathname,
|
|
296
|
+
dataRouterContext
|
|
297
|
+
]);
|
|
298
|
+
}
|
|
299
|
+
const OutletContext = React$1.createContext(null);
|
|
300
|
+
/**
|
|
301
|
+
* Returns the parent route {@link Outlet | `<Outlet context>`}.
|
|
302
|
+
*
|
|
303
|
+
* Often parent routes manage state or other values you want shared with child
|
|
304
|
+
* routes. You can create your own [context provider](https://react.dev/learn/passing-data-deeply-with-context)
|
|
305
|
+
* if you like, but this is such a common situation that it's built-into
|
|
306
|
+
* {@link Outlet | `<Outlet>`}.
|
|
307
|
+
*
|
|
308
|
+
* ```tsx
|
|
309
|
+
* // Parent route
|
|
310
|
+
* function Parent() {
|
|
311
|
+
* const [count, setCount] = React.useState(0);
|
|
312
|
+
* return <Outlet context={[count, setCount]} />;
|
|
313
|
+
* }
|
|
314
|
+
* ```
|
|
315
|
+
*
|
|
316
|
+
* ```tsx
|
|
317
|
+
* // Child route
|
|
318
|
+
* import { useOutletContext } from "react-router";
|
|
319
|
+
*
|
|
320
|
+
* function Child() {
|
|
321
|
+
* const [count, setCount] = useOutletContext();
|
|
322
|
+
* const increment = () => setCount((c) => c + 1);
|
|
323
|
+
* return <button onClick={increment}>{count}</button>;
|
|
324
|
+
* }
|
|
325
|
+
* ```
|
|
326
|
+
*
|
|
327
|
+
* If you're using TypeScript, we recommend the parent component provide a
|
|
328
|
+
* custom hook for accessing the context value. This makes it easier for
|
|
329
|
+
* consumers to get nice typings, control consumers, and know who's consuming
|
|
330
|
+
* the context value.
|
|
331
|
+
*
|
|
332
|
+
* Here's a more realistic example:
|
|
333
|
+
*
|
|
334
|
+
* ```tsx filename=src/routes/dashboard.tsx lines=[14,20]
|
|
335
|
+
* import { useState } from "react";
|
|
336
|
+
* import { Outlet, useOutletContext } from "react-router";
|
|
337
|
+
*
|
|
338
|
+
* import type { User } from "./types";
|
|
339
|
+
*
|
|
340
|
+
* type ContextType = { user: User | null };
|
|
341
|
+
*
|
|
342
|
+
* export default function Dashboard() {
|
|
343
|
+
* const [user, setUser] = useState<User | null>(null);
|
|
344
|
+
*
|
|
345
|
+
* return (
|
|
346
|
+
* <div>
|
|
347
|
+
* <h1>Dashboard</h1>
|
|
348
|
+
* <Outlet context={{ user } satisfies ContextType} />
|
|
349
|
+
* </div>
|
|
350
|
+
* );
|
|
351
|
+
* }
|
|
352
|
+
*
|
|
353
|
+
* export function useUser() {
|
|
354
|
+
* return useOutletContext<ContextType>();
|
|
355
|
+
* }
|
|
356
|
+
* ```
|
|
357
|
+
*
|
|
358
|
+
* ```tsx filename=src/routes/dashboard/messages.tsx lines=[1,4]
|
|
359
|
+
* import { useUser } from "../dashboard";
|
|
360
|
+
*
|
|
361
|
+
* export default function DashboardMessages() {
|
|
362
|
+
* const { user } = useUser();
|
|
363
|
+
* return (
|
|
364
|
+
* <div>
|
|
365
|
+
* <h2>Messages</h2>
|
|
366
|
+
* <p>Hello, {user.name}!</p>
|
|
367
|
+
* </div>
|
|
368
|
+
* );
|
|
369
|
+
* }
|
|
370
|
+
* ```
|
|
371
|
+
*
|
|
372
|
+
* @public
|
|
373
|
+
* @category Hooks
|
|
374
|
+
* @returns The context value passed to the parent {@link Outlet} component
|
|
375
|
+
*/
|
|
376
|
+
function useOutletContext() {
|
|
377
|
+
return React$1.useContext(OutletContext);
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* Returns the element for the child route at this level of the route
|
|
381
|
+
* hierarchy. Used internally by {@link Outlet | `<Outlet>`} to render child
|
|
382
|
+
* routes.
|
|
383
|
+
*
|
|
384
|
+
* @public
|
|
385
|
+
* @category Hooks
|
|
386
|
+
* @param context The context to pass to the outlet
|
|
387
|
+
* @returns The child route element or `null` if no child routes match
|
|
388
|
+
*/
|
|
389
|
+
function useOutlet(context) {
|
|
390
|
+
let outlet = React$1.useContext(RouteContext).outlet;
|
|
391
|
+
return React$1.useMemo(() => outlet && /* @__PURE__ */ React$1.createElement(OutletContext.Provider, { value: context }, outlet), [outlet, context]);
|
|
392
|
+
}
|
|
393
|
+
/**
|
|
394
|
+
* Returns an object of key/value-pairs of the dynamic params from the current
|
|
395
|
+
* URL that were matched by the routes. Child routes inherit all params from
|
|
396
|
+
* their parent routes.
|
|
397
|
+
*
|
|
398
|
+
* Assuming a route pattern like `/posts/:postId` is matched by `/posts/123`
|
|
399
|
+
* then `params.postId` will be `"123"`.
|
|
400
|
+
*
|
|
401
|
+
* @example
|
|
402
|
+
* import { useParams } from "react-router";
|
|
403
|
+
*
|
|
404
|
+
* function SomeComponent() {
|
|
405
|
+
* let params = useParams();
|
|
406
|
+
* params.postId;
|
|
407
|
+
* }
|
|
408
|
+
*
|
|
409
|
+
* @additionalExamples
|
|
410
|
+
* ### Basic Usage
|
|
411
|
+
*
|
|
412
|
+
* ```tsx
|
|
413
|
+
* import { useParams } from "react-router";
|
|
414
|
+
*
|
|
415
|
+
* // given a route like:
|
|
416
|
+
* <Route path="/posts/:postId" element={<Post />} />;
|
|
417
|
+
*
|
|
418
|
+
* // or a data route like:
|
|
419
|
+
* createBrowserRouter([
|
|
420
|
+
* {
|
|
421
|
+
* path: "/posts/:postId",
|
|
422
|
+
* component: Post,
|
|
423
|
+
* },
|
|
424
|
+
* ]);
|
|
425
|
+
*
|
|
426
|
+
* // or in routes.ts
|
|
427
|
+
* route("/posts/:postId", "routes/post.tsx");
|
|
428
|
+
* ```
|
|
429
|
+
*
|
|
430
|
+
* Access the params in a component:
|
|
431
|
+
*
|
|
432
|
+
* ```tsx
|
|
433
|
+
* import { useParams } from "react-router";
|
|
434
|
+
*
|
|
435
|
+
* export default function Post() {
|
|
436
|
+
* let params = useParams();
|
|
437
|
+
* return <h1>Post: {params.postId}</h1>;
|
|
438
|
+
* }
|
|
439
|
+
* ```
|
|
440
|
+
*
|
|
441
|
+
* ### Multiple Params
|
|
442
|
+
*
|
|
443
|
+
* Patterns can have multiple params:
|
|
444
|
+
*
|
|
445
|
+
* ```tsx
|
|
446
|
+
* "/posts/:postId/comments/:commentId";
|
|
447
|
+
* ```
|
|
448
|
+
*
|
|
449
|
+
* All will be available in the params object:
|
|
450
|
+
*
|
|
451
|
+
* ```tsx
|
|
452
|
+
* import { useParams } from "react-router";
|
|
453
|
+
*
|
|
454
|
+
* export default function Post() {
|
|
455
|
+
* let params = useParams();
|
|
456
|
+
* return (
|
|
457
|
+
* <h1>
|
|
458
|
+
* Post: {params.postId}, Comment: {params.commentId}
|
|
459
|
+
* </h1>
|
|
460
|
+
* );
|
|
461
|
+
* }
|
|
462
|
+
* ```
|
|
463
|
+
*
|
|
464
|
+
* ### Catchall Params
|
|
465
|
+
*
|
|
466
|
+
* Catchall params are defined with `*`:
|
|
467
|
+
*
|
|
468
|
+
* ```tsx
|
|
469
|
+
* "/files/*";
|
|
470
|
+
* ```
|
|
471
|
+
*
|
|
472
|
+
* The matched value will be available in the params object as follows:
|
|
473
|
+
*
|
|
474
|
+
* ```tsx
|
|
475
|
+
* import { useParams } from "react-router";
|
|
476
|
+
*
|
|
477
|
+
* export default function File() {
|
|
478
|
+
* let params = useParams();
|
|
479
|
+
* let catchall = params["*"];
|
|
480
|
+
* // ...
|
|
481
|
+
* }
|
|
482
|
+
* ```
|
|
483
|
+
*
|
|
484
|
+
* You can destructure the catchall param:
|
|
485
|
+
*
|
|
486
|
+
* ```tsx
|
|
487
|
+
* export default function File() {
|
|
488
|
+
* let { "*": catchall } = useParams();
|
|
489
|
+
* console.log(catchall);
|
|
490
|
+
* }
|
|
491
|
+
* ```
|
|
492
|
+
*
|
|
493
|
+
* @public
|
|
494
|
+
* @category Hooks
|
|
495
|
+
* @returns An object containing the dynamic route parameters
|
|
496
|
+
*/
|
|
497
|
+
function useParams() {
|
|
498
|
+
let { matches } = React$1.useContext(RouteContext);
|
|
499
|
+
return matches[matches.length - 1]?.params ?? {};
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* Resolves the pathname of the given `to` value against the current
|
|
503
|
+
* {@link Location}. Similar to {@link useHref}, but returns a
|
|
504
|
+
* {@link Path} instead of a string.
|
|
505
|
+
*
|
|
506
|
+
* @example
|
|
507
|
+
* import { useResolvedPath } from "react-router";
|
|
508
|
+
*
|
|
509
|
+
* function SomeComponent() {
|
|
510
|
+
* // if the user is at /dashboard/profile
|
|
511
|
+
* let path = useResolvedPath("../accounts");
|
|
512
|
+
* path.pathname; // "/dashboard/accounts"
|
|
513
|
+
* path.search; // ""
|
|
514
|
+
* path.hash; // ""
|
|
515
|
+
* }
|
|
516
|
+
*
|
|
517
|
+
* @public
|
|
518
|
+
* @category Hooks
|
|
519
|
+
* @param to The path to resolve
|
|
520
|
+
* @param options Options
|
|
521
|
+
* @param options.relative Defaults to `"route"` so routing is relative to the route tree.
|
|
522
|
+
* Set to `"path"` to make relative routing operate against path segments.
|
|
523
|
+
* @returns The resolved {@link Path} object with `pathname`, `search`, and `hash`
|
|
524
|
+
*/
|
|
525
|
+
function useResolvedPath(to, { relative } = {}) {
|
|
526
|
+
let { matches } = React$1.useContext(RouteContext);
|
|
527
|
+
let { pathname: locationPathname } = useLocation();
|
|
528
|
+
let routePathnamesJson = JSON.stringify(getResolveToMatches(matches));
|
|
529
|
+
return React$1.useMemo(() => resolveTo(to, JSON.parse(routePathnamesJson), locationPathname, relative === "path"), [
|
|
530
|
+
to,
|
|
531
|
+
routePathnamesJson,
|
|
532
|
+
locationPathname,
|
|
533
|
+
relative
|
|
534
|
+
]);
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* Hook version of {@link Routes | `<Routes>`} that uses objects instead of
|
|
538
|
+
* components. These objects have the same properties as the component props.
|
|
539
|
+
* The return value of `useRoutes` is either a valid React element you can use
|
|
540
|
+
* to render the route tree, or `null` if nothing matched.
|
|
541
|
+
*
|
|
542
|
+
* @example
|
|
543
|
+
* import { useRoutes } from "react-router";
|
|
544
|
+
*
|
|
545
|
+
* function App() {
|
|
546
|
+
* let element = useRoutes([
|
|
547
|
+
* {
|
|
548
|
+
* path: "/",
|
|
549
|
+
* element: <Dashboard />,
|
|
550
|
+
* children: [
|
|
551
|
+
* {
|
|
552
|
+
* path: "messages",
|
|
553
|
+
* element: <DashboardMessages />,
|
|
554
|
+
* },
|
|
555
|
+
* { path: "tasks", element: <DashboardTasks /> },
|
|
556
|
+
* ],
|
|
557
|
+
* },
|
|
558
|
+
* { path: "team", element: <AboutPage /> },
|
|
559
|
+
* ]);
|
|
560
|
+
*
|
|
561
|
+
* return element;
|
|
562
|
+
* }
|
|
563
|
+
*
|
|
564
|
+
* @public
|
|
565
|
+
* @category Hooks
|
|
566
|
+
* @param routes An array of {@link RouteObject}s that define the route hierarchy
|
|
567
|
+
* @param locationArg An optional {@link Location} object or pathname string to
|
|
568
|
+
* use instead of the current {@link Location}
|
|
569
|
+
* @returns A React element to render the matched route, or `null` if no routes matched
|
|
570
|
+
*/
|
|
571
|
+
function useRoutes(routes, locationArg) {
|
|
572
|
+
return useRoutesImpl(routes, locationArg);
|
|
573
|
+
}
|
|
574
|
+
function useRoutesImpl(routes, locationArg, dataRouterOpts) {
|
|
575
|
+
invariant(useInRouterContext(), `useRoutes() may be used only in the context of a <Router> component.`);
|
|
576
|
+
let { navigator } = React$1.useContext(NavigationContext);
|
|
577
|
+
let { matches: parentMatches } = React$1.useContext(RouteContext);
|
|
578
|
+
let routeMatch = parentMatches[parentMatches.length - 1];
|
|
579
|
+
let parentParams = routeMatch ? routeMatch.params : {};
|
|
580
|
+
routeMatch && routeMatch.pathname;
|
|
581
|
+
let parentPathnameBase = routeMatch ? routeMatch.pathnameBase : "/";
|
|
582
|
+
routeMatch && routeMatch.route;
|
|
583
|
+
let locationFromContext = useLocation();
|
|
584
|
+
let location;
|
|
585
|
+
if (locationArg) {
|
|
586
|
+
let parsedLocationArg = typeof locationArg === "string" ? parsePath(locationArg) : locationArg;
|
|
587
|
+
invariant(parentPathnameBase === "/" || parsedLocationArg.pathname?.startsWith(parentPathnameBase), `When overriding the location using \`<Routes location>\` or \`useRoutes(routes, location)\`, the location pathname must begin with the portion of the URL pathname that was matched by all parent routes. The current pathname base is "${parentPathnameBase}" but pathname "${parsedLocationArg.pathname}" was given in the \`location\` prop.`);
|
|
588
|
+
location = parsedLocationArg;
|
|
589
|
+
} else location = locationFromContext;
|
|
590
|
+
let pathname = location.pathname || "/";
|
|
591
|
+
let remainingPathname = pathname;
|
|
592
|
+
if (parentPathnameBase !== "/") {
|
|
593
|
+
let parentSegments = parentPathnameBase.replace(/^\//, "").split("/");
|
|
594
|
+
remainingPathname = "/" + pathname.replace(/^\//, "").split("/").slice(parentSegments.length).join("/");
|
|
595
|
+
}
|
|
596
|
+
let matches = dataRouterOpts && dataRouterOpts.state.matches.length ? dataRouterOpts.state.matches.map((m) => Object.assign(m, { route: dataRouterOpts.manifest[m.route.id] || m.route })) : matchRoutes(routes, { pathname: remainingPathname });
|
|
597
|
+
let renderedMatches = _renderMatches(matches && matches.map((match) => Object.assign({}, match, {
|
|
598
|
+
params: Object.assign({}, parentParams, match.params),
|
|
599
|
+
pathname: joinPaths([parentPathnameBase, navigator.encodeLocation ? navigator.encodeLocation(match.pathname.replace(/%/g, "%25").replace(/\?/g, "%3F").replace(/#/g, "%23")).pathname : match.pathname]),
|
|
600
|
+
pathnameBase: match.pathnameBase === "/" ? parentPathnameBase : joinPaths([parentPathnameBase, navigator.encodeLocation ? navigator.encodeLocation(match.pathnameBase.replace(/%/g, "%25").replace(/\?/g, "%3F").replace(/#/g, "%23")).pathname : match.pathnameBase])
|
|
601
|
+
})), parentMatches, dataRouterOpts);
|
|
602
|
+
if (locationArg && renderedMatches) return /* @__PURE__ */ React$1.createElement(LocationContext.Provider, { value: {
|
|
603
|
+
location: {
|
|
604
|
+
pathname: "/",
|
|
605
|
+
search: "",
|
|
606
|
+
hash: "",
|
|
607
|
+
state: null,
|
|
608
|
+
key: "default",
|
|
609
|
+
mask: void 0,
|
|
610
|
+
...location
|
|
611
|
+
},
|
|
612
|
+
navigationType: "POP"
|
|
613
|
+
} }, renderedMatches);
|
|
614
|
+
return renderedMatches;
|
|
615
|
+
}
|
|
616
|
+
function DefaultErrorComponent() {
|
|
617
|
+
let error = useRouteError();
|
|
618
|
+
let message = isRouteErrorResponse(error) ? `${error.status} ${error.statusText}` : error instanceof Error ? error.message : JSON.stringify(error);
|
|
619
|
+
let stack = error instanceof Error ? error.stack : null;
|
|
620
|
+
return /* @__PURE__ */ React$1.createElement(React$1.Fragment, null, /* @__PURE__ */ React$1.createElement("h2", null, "Unexpected Application Error!"), /* @__PURE__ */ React$1.createElement("h3", { style: { fontStyle: "italic" } }, message), stack ? /* @__PURE__ */ React$1.createElement("pre", { style: {
|
|
621
|
+
padding: "0.5rem",
|
|
622
|
+
backgroundColor: "rgba(200,200,200, 0.5)"
|
|
623
|
+
} }, stack) : null, null);
|
|
624
|
+
}
|
|
625
|
+
const defaultErrorElement = /* @__PURE__ */ React$1.createElement(DefaultErrorComponent, null);
|
|
626
|
+
var RenderErrorBoundary = class extends React$1.Component {
|
|
627
|
+
constructor(props) {
|
|
628
|
+
super(props);
|
|
629
|
+
this.state = {
|
|
630
|
+
location: props.location,
|
|
631
|
+
revalidation: props.revalidation,
|
|
632
|
+
error: props.error
|
|
633
|
+
};
|
|
634
|
+
}
|
|
635
|
+
static contextType = RSCRouterContext;
|
|
636
|
+
static getDerivedStateFromError(error) {
|
|
637
|
+
return { error };
|
|
638
|
+
}
|
|
639
|
+
static getDerivedStateFromProps(props, state) {
|
|
640
|
+
if (state.location !== props.location || state.revalidation !== "idle" && props.revalidation === "idle") return {
|
|
641
|
+
error: props.error,
|
|
642
|
+
location: props.location,
|
|
643
|
+
revalidation: props.revalidation
|
|
644
|
+
};
|
|
645
|
+
return {
|
|
646
|
+
error: props.error !== void 0 ? props.error : state.error,
|
|
647
|
+
location: state.location,
|
|
648
|
+
revalidation: props.revalidation || state.revalidation
|
|
649
|
+
};
|
|
650
|
+
}
|
|
651
|
+
componentDidCatch(error, errorInfo) {
|
|
652
|
+
if (this.props.onError) this.props.onError(error, errorInfo);
|
|
653
|
+
else console.error("React Router caught the following error during render", error);
|
|
654
|
+
}
|
|
655
|
+
render() {
|
|
656
|
+
let error = this.state.error;
|
|
657
|
+
if (this.context && typeof error === "object" && error && "digest" in error && typeof error.digest === "string") {
|
|
658
|
+
const decoded = decodeRouteErrorResponseDigest(error.digest);
|
|
659
|
+
if (decoded) error = decoded;
|
|
660
|
+
}
|
|
661
|
+
let result = error !== void 0 ? /* @__PURE__ */ React$1.createElement(RouteContext.Provider, { value: this.props.routeContext }, /* @__PURE__ */ React$1.createElement(RouteErrorContext.Provider, {
|
|
662
|
+
value: error,
|
|
663
|
+
children: this.props.component
|
|
664
|
+
})) : this.props.children;
|
|
665
|
+
if (this.context) return /* @__PURE__ */ React$1.createElement(RSCErrorHandler, { error }, result);
|
|
666
|
+
return result;
|
|
667
|
+
}
|
|
668
|
+
};
|
|
669
|
+
const errorRedirectHandledMap = /* @__PURE__ */ new WeakMap();
|
|
670
|
+
function RSCErrorHandler({ children, error }) {
|
|
671
|
+
let { basename } = React$1.useContext(NavigationContext);
|
|
672
|
+
if (typeof error === "object" && error && "digest" in error && typeof error.digest === "string") {
|
|
673
|
+
let redirect = decodeRedirectErrorDigest(error.digest);
|
|
674
|
+
if (redirect) {
|
|
675
|
+
let existingRedirect = errorRedirectHandledMap.get(error);
|
|
676
|
+
if (existingRedirect) throw existingRedirect;
|
|
677
|
+
let parsed = parseToInfo(redirect.location, basename);
|
|
678
|
+
if (isBrowser && !errorRedirectHandledMap.get(error)) if (parsed.isExternal || redirect.reloadDocument) window.location.href = parsed.absoluteURL || parsed.to;
|
|
679
|
+
else {
|
|
680
|
+
const redirectPromise = Promise.resolve().then(() => window.__reactRouterDataRouter.navigate(parsed.to, { replace: redirect.replace }));
|
|
681
|
+
errorRedirectHandledMap.set(error, redirectPromise);
|
|
682
|
+
throw redirectPromise;
|
|
683
|
+
}
|
|
684
|
+
return /* @__PURE__ */ React$1.createElement("meta", {
|
|
685
|
+
httpEquiv: "refresh",
|
|
686
|
+
content: `0;url=${parsed.absoluteURL || parsed.to}`
|
|
687
|
+
});
|
|
688
|
+
}
|
|
689
|
+
}
|
|
690
|
+
return children;
|
|
691
|
+
}
|
|
692
|
+
function RenderedRoute({ routeContext, match, children }) {
|
|
693
|
+
let dataRouterContext = React$1.useContext(DataRouterContext);
|
|
694
|
+
if (dataRouterContext && dataRouterContext.static && dataRouterContext.staticContext && (match.route.errorElement || match.route.ErrorBoundary)) dataRouterContext.staticContext._deepestRenderedBoundaryId = match.route.id;
|
|
695
|
+
return /* @__PURE__ */ React$1.createElement(RouteContext.Provider, { value: routeContext }, children);
|
|
696
|
+
}
|
|
697
|
+
function _renderMatches(matches, parentMatches = [], dataRouterOpts) {
|
|
698
|
+
let dataRouterState = dataRouterOpts?.state;
|
|
699
|
+
if (matches == null) {
|
|
700
|
+
if (!dataRouterState) return null;
|
|
701
|
+
if (dataRouterState.errors) matches = dataRouterState.matches;
|
|
702
|
+
else if (parentMatches.length === 0 && !dataRouterState.initialized && dataRouterState.matches.length > 0) matches = dataRouterState.matches;
|
|
703
|
+
else return null;
|
|
704
|
+
}
|
|
705
|
+
let renderedMatches = matches;
|
|
706
|
+
let errors = dataRouterState?.errors;
|
|
707
|
+
if (errors != null) {
|
|
708
|
+
let errorIndex = renderedMatches.findIndex((m) => m.route.id && errors?.[m.route.id] !== void 0);
|
|
709
|
+
invariant(errorIndex >= 0, `Could not find a matching route for errors on route IDs: ${Object.keys(errors).join(",")}`);
|
|
710
|
+
renderedMatches = renderedMatches.slice(0, Math.min(renderedMatches.length, errorIndex + 1));
|
|
711
|
+
}
|
|
712
|
+
let renderFallback = false;
|
|
713
|
+
let fallbackIndex = -1;
|
|
714
|
+
if (dataRouterOpts && dataRouterState) {
|
|
715
|
+
renderFallback = dataRouterState.renderFallback;
|
|
716
|
+
for (let i = 0; i < renderedMatches.length; i++) {
|
|
717
|
+
let match = renderedMatches[i];
|
|
718
|
+
if (match.route.HydrateFallback || match.route.hydrateFallbackElement) fallbackIndex = i;
|
|
719
|
+
if (match.route.id) {
|
|
720
|
+
let { loaderData, errors } = dataRouterState;
|
|
721
|
+
let needsToRunLoader = match.route.loader && !loaderData.hasOwnProperty(match.route.id) && (!errors || errors[match.route.id] === void 0);
|
|
722
|
+
if (match.route.lazy || needsToRunLoader) {
|
|
723
|
+
if (dataRouterOpts.isStatic) renderFallback = true;
|
|
724
|
+
if (fallbackIndex >= 0) renderedMatches = renderedMatches.slice(0, fallbackIndex + 1);
|
|
725
|
+
else renderedMatches = [renderedMatches[0]];
|
|
726
|
+
break;
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
let onErrorHandler = dataRouterOpts?.onError;
|
|
732
|
+
let onError = dataRouterState && onErrorHandler ? (error, errorInfo) => {
|
|
733
|
+
onErrorHandler(error, {
|
|
734
|
+
location: dataRouterState.location,
|
|
735
|
+
params: dataRouterState.matches?.[0]?.params ?? {},
|
|
736
|
+
pattern: getRoutePattern(dataRouterState.matches),
|
|
737
|
+
errorInfo
|
|
738
|
+
});
|
|
739
|
+
} : void 0;
|
|
740
|
+
return renderedMatches.reduceRight((outlet, match, index) => {
|
|
741
|
+
let error;
|
|
742
|
+
let shouldRenderHydrateFallback = false;
|
|
743
|
+
let errorElement = null;
|
|
744
|
+
let hydrateFallbackElement = null;
|
|
745
|
+
if (dataRouterState) {
|
|
746
|
+
error = errors && match.route.id ? errors[match.route.id] : void 0;
|
|
747
|
+
errorElement = match.route.errorElement || defaultErrorElement;
|
|
748
|
+
if (renderFallback) {
|
|
749
|
+
if (fallbackIndex < 0 && index === 0) {
|
|
750
|
+
warningOnce("route-fallback", false, "No `HydrateFallback` element provided to render during initial hydration");
|
|
751
|
+
shouldRenderHydrateFallback = true;
|
|
752
|
+
hydrateFallbackElement = null;
|
|
753
|
+
} else if (fallbackIndex === index) {
|
|
754
|
+
shouldRenderHydrateFallback = true;
|
|
755
|
+
hydrateFallbackElement = match.route.hydrateFallbackElement || null;
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
let matches = parentMatches.concat(renderedMatches.slice(0, index + 1));
|
|
760
|
+
let getChildren = () => {
|
|
761
|
+
let children;
|
|
762
|
+
if (error) children = errorElement;
|
|
763
|
+
else if (shouldRenderHydrateFallback) children = hydrateFallbackElement;
|
|
764
|
+
else if (match.route.Component) children = /* @__PURE__ */ React$1.createElement(match.route.Component, null);
|
|
765
|
+
else if (match.route.element) children = match.route.element;
|
|
766
|
+
else children = outlet;
|
|
767
|
+
return /* @__PURE__ */ React$1.createElement(RenderedRoute, {
|
|
768
|
+
match,
|
|
769
|
+
routeContext: {
|
|
770
|
+
outlet,
|
|
771
|
+
matches,
|
|
772
|
+
isDataRoute: dataRouterState != null
|
|
773
|
+
},
|
|
774
|
+
children
|
|
775
|
+
});
|
|
776
|
+
};
|
|
777
|
+
return dataRouterState && (match.route.ErrorBoundary || match.route.errorElement || index === 0) ? /* @__PURE__ */ React$1.createElement(RenderErrorBoundary, {
|
|
778
|
+
location: dataRouterState.location,
|
|
779
|
+
revalidation: dataRouterState.revalidation,
|
|
780
|
+
component: errorElement,
|
|
781
|
+
error,
|
|
782
|
+
children: getChildren(),
|
|
783
|
+
routeContext: {
|
|
784
|
+
outlet: null,
|
|
785
|
+
matches,
|
|
786
|
+
isDataRoute: true
|
|
787
|
+
},
|
|
788
|
+
onError
|
|
789
|
+
}) : getChildren();
|
|
790
|
+
}, null);
|
|
791
|
+
}
|
|
792
|
+
function getDataRouterConsoleError(hookName) {
|
|
793
|
+
return `${hookName} must be used within a data router. See https://reactrouter.com/en/main/routers/picking-a-router.`;
|
|
794
|
+
}
|
|
795
|
+
function useDataRouterContext(hookName) {
|
|
796
|
+
let ctx = React$1.useContext(DataRouterContext);
|
|
797
|
+
invariant(ctx, getDataRouterConsoleError(hookName));
|
|
798
|
+
return ctx;
|
|
799
|
+
}
|
|
800
|
+
function useDataRouterState(hookName) {
|
|
801
|
+
let state = React$1.useContext(DataRouterStateContext);
|
|
802
|
+
invariant(state, getDataRouterConsoleError(hookName));
|
|
803
|
+
return state;
|
|
804
|
+
}
|
|
805
|
+
function useRouteContext(hookName) {
|
|
806
|
+
let route = React$1.useContext(RouteContext);
|
|
807
|
+
invariant(route, getDataRouterConsoleError(hookName));
|
|
808
|
+
return route;
|
|
809
|
+
}
|
|
810
|
+
function useCurrentRouteId(hookName) {
|
|
811
|
+
let route = useRouteContext(hookName);
|
|
812
|
+
let thisRoute = route.matches[route.matches.length - 1];
|
|
813
|
+
invariant(thisRoute.route.id, `${hookName} can only be used on routes that contain a unique "id"`);
|
|
814
|
+
return thisRoute.route.id;
|
|
815
|
+
}
|
|
816
|
+
/**
|
|
817
|
+
* Returns the ID for the nearest contextual route
|
|
818
|
+
*
|
|
819
|
+
* @category Hooks
|
|
820
|
+
* @returns The ID of the nearest contextual route
|
|
821
|
+
*/
|
|
822
|
+
function useRouteId() {
|
|
823
|
+
return useCurrentRouteId("useRouteId");
|
|
824
|
+
}
|
|
825
|
+
/**
|
|
826
|
+
* Returns the current {@link Navigation}, defaulting to an "idle" navigation
|
|
827
|
+
* when no navigation is in progress. You can use this to render pending UI
|
|
828
|
+
* (like a global spinner) or read [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData)
|
|
829
|
+
* from a form navigation.
|
|
830
|
+
*
|
|
831
|
+
* @example
|
|
832
|
+
* import { useNavigation } from "react-router";
|
|
833
|
+
*
|
|
834
|
+
* function SomeComponent() {
|
|
835
|
+
* let navigation = useNavigation();
|
|
836
|
+
* navigation.state;
|
|
837
|
+
* navigation.formData;
|
|
838
|
+
* // etc.
|
|
839
|
+
* }
|
|
840
|
+
*
|
|
841
|
+
* @public
|
|
842
|
+
* @category Hooks
|
|
843
|
+
* @mode framework
|
|
844
|
+
* @mode data
|
|
845
|
+
* @returns The current {@link Navigation} object
|
|
846
|
+
*/
|
|
847
|
+
function useNavigation() {
|
|
848
|
+
let state = useDataRouterState("useNavigation");
|
|
849
|
+
return React$1.useMemo(() => {
|
|
850
|
+
let { matches, historyAction, ...rest } = state.navigation;
|
|
851
|
+
return rest;
|
|
852
|
+
}, [state.navigation]);
|
|
853
|
+
}
|
|
854
|
+
/**
|
|
855
|
+
* Revalidate the data on the page for reasons outside of normal data mutations
|
|
856
|
+
* like [`Window` focus](https://developer.mozilla.org/en-US/docs/Web/API/Window/focus_event)
|
|
857
|
+
* or polling on an interval.
|
|
858
|
+
*
|
|
859
|
+
* Note that page data is already revalidated automatically after actions.
|
|
860
|
+
* If you find yourself using this for normal CRUD operations on your data in
|
|
861
|
+
* response to user interactions, you're probably not taking advantage of the
|
|
862
|
+
* other APIs like {@link useFetcher}, {@link Form}, {@link useSubmit} that do
|
|
863
|
+
* this automatically.
|
|
864
|
+
*
|
|
865
|
+
* @example
|
|
866
|
+
* import { useRevalidator } from "react-router";
|
|
867
|
+
*
|
|
868
|
+
* function WindowFocusRevalidator() {
|
|
869
|
+
* const revalidator = useRevalidator();
|
|
870
|
+
*
|
|
871
|
+
* useFakeWindowFocus(() => {
|
|
872
|
+
* revalidator.revalidate();
|
|
873
|
+
* });
|
|
874
|
+
*
|
|
875
|
+
* return (
|
|
876
|
+
* <div hidden={revalidator.state === "idle"}>
|
|
877
|
+
* Revalidating...
|
|
878
|
+
* </div>
|
|
879
|
+
* );
|
|
880
|
+
* }
|
|
881
|
+
*
|
|
882
|
+
* @public
|
|
883
|
+
* @category Hooks
|
|
884
|
+
* @mode framework
|
|
885
|
+
* @mode data
|
|
886
|
+
* @returns An object with a `revalidate` function and the current revalidation
|
|
887
|
+
* `state`
|
|
888
|
+
*/
|
|
889
|
+
function useRevalidator() {
|
|
890
|
+
let dataRouterContext = useDataRouterContext("useRevalidator");
|
|
891
|
+
let state = useDataRouterState("useRevalidator");
|
|
892
|
+
let revalidate = React$1.useCallback(async () => {
|
|
893
|
+
await dataRouterContext.router.revalidate();
|
|
894
|
+
}, [dataRouterContext.router]);
|
|
895
|
+
return React$1.useMemo(() => ({
|
|
896
|
+
revalidate,
|
|
897
|
+
state: state.revalidation
|
|
898
|
+
}), [revalidate, state.revalidation]);
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* Returns the active route matches, useful for accessing `loaderData` for
|
|
902
|
+
* parent/child routes or the route [`handle`](../../start/framework/route-module#handle)
|
|
903
|
+
* property
|
|
904
|
+
*
|
|
905
|
+
* @public
|
|
906
|
+
* @category Hooks
|
|
907
|
+
* @mode framework
|
|
908
|
+
* @mode data
|
|
909
|
+
* @returns An array of {@link UIMatch | UI matches} for the current route hierarchy
|
|
910
|
+
*/
|
|
911
|
+
function useMatches() {
|
|
912
|
+
let { matches, loaderData } = useDataRouterState("useMatches");
|
|
913
|
+
return React$1.useMemo(() => matches.map((m) => convertRouteMatchToUiMatch(m, loaderData)), [matches, loaderData]);
|
|
914
|
+
}
|
|
915
|
+
/**
|
|
916
|
+
* Returns the data from the closest route
|
|
917
|
+
* [`loader`](../../start/framework/route-module#loader) or
|
|
918
|
+
* [`clientLoader`](../../start/framework/route-module#clientloader).
|
|
919
|
+
*
|
|
920
|
+
* @example
|
|
921
|
+
* import { useLoaderData } from "react-router";
|
|
922
|
+
*
|
|
923
|
+
* export async function loader() {
|
|
924
|
+
* return await fakeDb.invoices.findAll();
|
|
925
|
+
* }
|
|
926
|
+
*
|
|
927
|
+
* export default function Invoices() {
|
|
928
|
+
* let invoices = useLoaderData<typeof loader>();
|
|
929
|
+
* // ...
|
|
930
|
+
* }
|
|
931
|
+
*
|
|
932
|
+
* @public
|
|
933
|
+
* @category Hooks
|
|
934
|
+
* @mode framework
|
|
935
|
+
* @mode data
|
|
936
|
+
* @returns The data returned from the route's [`loader`](../../start/framework/route-module#loader) or [`clientLoader`](../../start/framework/route-module#clientloader) function
|
|
937
|
+
*/
|
|
938
|
+
function useLoaderData() {
|
|
939
|
+
let state = useDataRouterState("useLoaderData");
|
|
940
|
+
let routeId = useCurrentRouteId("useLoaderData");
|
|
941
|
+
return state.loaderData[routeId];
|
|
942
|
+
}
|
|
943
|
+
/**
|
|
944
|
+
* Returns the [`loader`](../../start/framework/route-module#loader) data for a
|
|
945
|
+
* given route by route ID.
|
|
946
|
+
*
|
|
947
|
+
* Route IDs are created automatically. They are simply the path of the route file
|
|
948
|
+
* relative to the app folder without the extension.
|
|
949
|
+
*
|
|
950
|
+
* | Route Filename | Route ID |
|
|
951
|
+
* | ---------------------------- | ---------------------- |
|
|
952
|
+
* | `app/root.tsx` | `"root"` |
|
|
953
|
+
* | `app/routes/teams.tsx` | `"routes/teams"` |
|
|
954
|
+
* | `app/whatever/teams.$id.tsx` | `"whatever/teams.$id"` |
|
|
955
|
+
*
|
|
956
|
+
* @example
|
|
957
|
+
* import { useRouteLoaderData } from "react-router";
|
|
958
|
+
*
|
|
959
|
+
* function SomeComponent() {
|
|
960
|
+
* const { user } = useRouteLoaderData("root");
|
|
961
|
+
* }
|
|
962
|
+
*
|
|
963
|
+
* // You can also specify your own route ID's manually in your routes.ts file:
|
|
964
|
+
* route("/", "containers/app.tsx", { id: "app" })
|
|
965
|
+
* useRouteLoaderData("app");
|
|
966
|
+
*
|
|
967
|
+
* @public
|
|
968
|
+
* @category Hooks
|
|
969
|
+
* @mode framework
|
|
970
|
+
* @mode data
|
|
971
|
+
* @param routeId The ID of the route to return loader data from
|
|
972
|
+
* @returns The data returned from the specified route's [`loader`](../../start/framework/route-module#loader)
|
|
973
|
+
* function, or `undefined` if not found
|
|
974
|
+
*/
|
|
975
|
+
function useRouteLoaderData(routeId) {
|
|
976
|
+
return useDataRouterState("useRouteLoaderData").loaderData[routeId];
|
|
977
|
+
}
|
|
978
|
+
/**
|
|
979
|
+
* Returns the [`action`](../../start/framework/route-module#action) data from
|
|
980
|
+
* the most recent `POST` navigation form submission or `undefined` if there
|
|
981
|
+
* hasn't been one.
|
|
982
|
+
*
|
|
983
|
+
* @example
|
|
984
|
+
* import { Form, useActionData } from "react-router";
|
|
985
|
+
*
|
|
986
|
+
* export async function action({ request }) {
|
|
987
|
+
* const body = await request.formData();
|
|
988
|
+
* const name = body.get("visitorsName");
|
|
989
|
+
* return { message: `Hello, ${name}` };
|
|
990
|
+
* }
|
|
991
|
+
*
|
|
992
|
+
* export default function Invoices() {
|
|
993
|
+
* const data = useActionData();
|
|
994
|
+
* return (
|
|
995
|
+
* <Form method="post">
|
|
996
|
+
* <input type="text" name="visitorsName" />
|
|
997
|
+
* {data ? data.message : "Waiting..."}
|
|
998
|
+
* </Form>
|
|
999
|
+
* );
|
|
1000
|
+
* }
|
|
1001
|
+
*
|
|
1002
|
+
* @public
|
|
1003
|
+
* @category Hooks
|
|
1004
|
+
* @mode framework
|
|
1005
|
+
* @mode data
|
|
1006
|
+
* @returns The data returned from the route's [`action`](../../start/framework/route-module#action)
|
|
1007
|
+
* function, or `undefined` if no [`action`](../../start/framework/route-module#action)
|
|
1008
|
+
* has been called
|
|
1009
|
+
*/
|
|
1010
|
+
function useActionData() {
|
|
1011
|
+
let state = useDataRouterState("useActionData");
|
|
1012
|
+
let routeId = useCurrentRouteId("useLoaderData");
|
|
1013
|
+
return state.actionData ? state.actionData[routeId] : void 0;
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* Accesses the error thrown during an
|
|
1017
|
+
* [`action`](../../start/framework/route-module#action),
|
|
1018
|
+
* [`loader`](../../start/framework/route-module#loader),
|
|
1019
|
+
* or component render to be used in a route module
|
|
1020
|
+
* [`ErrorBoundary`](../../start/framework/route-module#errorboundary).
|
|
1021
|
+
*
|
|
1022
|
+
* @example
|
|
1023
|
+
* export function ErrorBoundary() {
|
|
1024
|
+
* const error = useRouteError();
|
|
1025
|
+
* return <div>{error.message}</div>;
|
|
1026
|
+
* }
|
|
1027
|
+
*
|
|
1028
|
+
* @public
|
|
1029
|
+
* @category Hooks
|
|
1030
|
+
* @mode framework
|
|
1031
|
+
* @mode data
|
|
1032
|
+
* @returns The error that was thrown during route [loading](../../start/framework/route-module#loader),
|
|
1033
|
+
* [`action`](../../start/framework/route-module#action) execution, or rendering
|
|
1034
|
+
*/
|
|
1035
|
+
function useRouteError() {
|
|
1036
|
+
let error = React$1.useContext(RouteErrorContext);
|
|
1037
|
+
let state = useDataRouterState("useRouteError");
|
|
1038
|
+
let routeId = useCurrentRouteId("useRouteError");
|
|
1039
|
+
if (error !== void 0) return error;
|
|
1040
|
+
return state.errors?.[routeId];
|
|
1041
|
+
}
|
|
1042
|
+
/**
|
|
1043
|
+
* Returns the resolved promise value from the closest {@link Await | `<Await>`}.
|
|
1044
|
+
*
|
|
1045
|
+
* @example
|
|
1046
|
+
* function SomeDescendant() {
|
|
1047
|
+
* const value = useAsyncValue();
|
|
1048
|
+
* // ...
|
|
1049
|
+
* }
|
|
1050
|
+
*
|
|
1051
|
+
* // somewhere in your app
|
|
1052
|
+
* <Await resolve={somePromise}>
|
|
1053
|
+
* <SomeDescendant />
|
|
1054
|
+
* </Await>;
|
|
1055
|
+
*
|
|
1056
|
+
* @public
|
|
1057
|
+
* @category Hooks
|
|
1058
|
+
* @mode framework
|
|
1059
|
+
* @mode data
|
|
1060
|
+
* @returns The resolved value from the nearest {@link Await} component
|
|
1061
|
+
*/
|
|
1062
|
+
function useAsyncValue() {
|
|
1063
|
+
return React$1.useContext(AwaitContext)?._data;
|
|
1064
|
+
}
|
|
1065
|
+
/**
|
|
1066
|
+
* Returns the rejection value from the closest {@link Await | `<Await>`}.
|
|
1067
|
+
*
|
|
1068
|
+
* @example
|
|
1069
|
+
* import { Await, useAsyncError } from "react-router";
|
|
1070
|
+
*
|
|
1071
|
+
* function ErrorElement() {
|
|
1072
|
+
* const error = useAsyncError();
|
|
1073
|
+
* return (
|
|
1074
|
+
* <p>Uh Oh, something went wrong! {error.message}</p>
|
|
1075
|
+
* );
|
|
1076
|
+
* }
|
|
1077
|
+
*
|
|
1078
|
+
* // somewhere in your app
|
|
1079
|
+
* <Await
|
|
1080
|
+
* resolve={promiseThatRejects}
|
|
1081
|
+
* errorElement={<ErrorElement />}
|
|
1082
|
+
* />;
|
|
1083
|
+
*
|
|
1084
|
+
* @public
|
|
1085
|
+
* @category Hooks
|
|
1086
|
+
* @mode framework
|
|
1087
|
+
* @mode data
|
|
1088
|
+
* @returns The error that was thrown in the nearest {@link Await} component
|
|
1089
|
+
*/
|
|
1090
|
+
function useAsyncError() {
|
|
1091
|
+
return React$1.useContext(AwaitContext)?._error;
|
|
1092
|
+
}
|
|
1093
|
+
let blockerId = 0;
|
|
1094
|
+
/**
|
|
1095
|
+
* Allow the application to block navigations within the SPA and present the
|
|
1096
|
+
* user a confirmation dialog to confirm the navigation. Mostly used to avoid
|
|
1097
|
+
* using half-filled form data. This does not handle hard-reloads or
|
|
1098
|
+
* cross-origin navigations.
|
|
1099
|
+
*
|
|
1100
|
+
* The {@link Blocker} object returned by the hook has the following properties:
|
|
1101
|
+
*
|
|
1102
|
+
* - **`state`**
|
|
1103
|
+
* - `unblocked` - the blocker is idle and has not prevented any navigation
|
|
1104
|
+
* - `blocked` - the blocker has prevented a navigation
|
|
1105
|
+
* - `proceeding` - the blocker is proceeding through from a blocked navigation
|
|
1106
|
+
* - **`location`**
|
|
1107
|
+
* - When in a `blocked` state, this represents the {@link Location} to which
|
|
1108
|
+
* we blocked a navigation. When in a `proceeding` state, this is the
|
|
1109
|
+
* location being navigated to after a `blocker.proceed()` call.
|
|
1110
|
+
* - **`proceed()`**
|
|
1111
|
+
* - When in a `blocked` state, you may call `blocker.proceed()` to proceed to
|
|
1112
|
+
* the blocked location.
|
|
1113
|
+
* - **`reset()`**
|
|
1114
|
+
* - When in a `blocked` state, you may call `blocker.reset()` to return the
|
|
1115
|
+
* blocker to an `unblocked` state and leave the user at the current
|
|
1116
|
+
* location.
|
|
1117
|
+
*
|
|
1118
|
+
* @example
|
|
1119
|
+
* // Boolean version
|
|
1120
|
+
* let blocker = useBlocker(value !== "");
|
|
1121
|
+
*
|
|
1122
|
+
* // Function version
|
|
1123
|
+
* let blocker = useBlocker(
|
|
1124
|
+
* ({ currentLocation, nextLocation, historyAction }) =>
|
|
1125
|
+
* value !== "" &&
|
|
1126
|
+
* currentLocation.pathname !== nextLocation.pathname
|
|
1127
|
+
* );
|
|
1128
|
+
*
|
|
1129
|
+
* @additionalExamples
|
|
1130
|
+
* ```tsx
|
|
1131
|
+
* import { useCallback, useState } from "react";
|
|
1132
|
+
* import { BlockerFunction, useBlocker } from "react-router";
|
|
1133
|
+
*
|
|
1134
|
+
* export function ImportantForm() {
|
|
1135
|
+
* const [value, setValue] = useState("");
|
|
1136
|
+
*
|
|
1137
|
+
* const shouldBlock = useCallback<BlockerFunction>(
|
|
1138
|
+
* () => value !== "",
|
|
1139
|
+
* [value]
|
|
1140
|
+
* );
|
|
1141
|
+
* const blocker = useBlocker(shouldBlock);
|
|
1142
|
+
*
|
|
1143
|
+
* return (
|
|
1144
|
+
* <form
|
|
1145
|
+
* onSubmit={(e) => {
|
|
1146
|
+
* e.preventDefault();
|
|
1147
|
+
* setValue("");
|
|
1148
|
+
* if (blocker.state === "blocked") {
|
|
1149
|
+
* blocker.proceed();
|
|
1150
|
+
* }
|
|
1151
|
+
* }}
|
|
1152
|
+
* >
|
|
1153
|
+
* <input
|
|
1154
|
+
* name="data"
|
|
1155
|
+
* value={value}
|
|
1156
|
+
* onChange={(e) => setValue(e.target.value)}
|
|
1157
|
+
* />
|
|
1158
|
+
*
|
|
1159
|
+
* <button type="submit">Save</button>
|
|
1160
|
+
*
|
|
1161
|
+
* {blocker.state === "blocked" ? (
|
|
1162
|
+
* <>
|
|
1163
|
+
* <p style={{ color: "red" }}>
|
|
1164
|
+
* Blocked the last navigation to
|
|
1165
|
+
* </p>
|
|
1166
|
+
* <button
|
|
1167
|
+
* type="button"
|
|
1168
|
+
* onClick={() => blocker.proceed()}
|
|
1169
|
+
* >
|
|
1170
|
+
* Let me through
|
|
1171
|
+
* </button>
|
|
1172
|
+
* <button
|
|
1173
|
+
* type="button"
|
|
1174
|
+
* onClick={() => blocker.reset()}
|
|
1175
|
+
* >
|
|
1176
|
+
* Keep me here
|
|
1177
|
+
* </button>
|
|
1178
|
+
* </>
|
|
1179
|
+
* ) : blocker.state === "proceeding" ? (
|
|
1180
|
+
* <p style={{ color: "orange" }}>
|
|
1181
|
+
* Proceeding through blocked navigation
|
|
1182
|
+
* </p>
|
|
1183
|
+
* ) : (
|
|
1184
|
+
* <p style={{ color: "green" }}>
|
|
1185
|
+
* Blocker is currently unblocked
|
|
1186
|
+
* </p>
|
|
1187
|
+
* )}
|
|
1188
|
+
* </form>
|
|
1189
|
+
* );
|
|
1190
|
+
* }
|
|
1191
|
+
* ```
|
|
1192
|
+
*
|
|
1193
|
+
* @public
|
|
1194
|
+
* @category Hooks
|
|
1195
|
+
* @mode framework
|
|
1196
|
+
* @mode data
|
|
1197
|
+
* @param shouldBlock Either a boolean or a function returning a boolean which
|
|
1198
|
+
* indicates whether the navigation should be blocked. The function format
|
|
1199
|
+
* receives a single object parameter containing the `currentLocation`,
|
|
1200
|
+
* `nextLocation`, and `historyAction` of the potential navigation.
|
|
1201
|
+
* @returns A {@link Blocker} object with state and reset functionality
|
|
1202
|
+
*/
|
|
1203
|
+
function useBlocker(shouldBlock) {
|
|
1204
|
+
let { router, basename } = useDataRouterContext("useBlocker");
|
|
1205
|
+
let state = useDataRouterState("useBlocker");
|
|
1206
|
+
let [blockerKey, setBlockerKey] = React$1.useState("");
|
|
1207
|
+
let blockerFunction = React$1.useCallback((arg) => {
|
|
1208
|
+
if (typeof shouldBlock !== "function") return !!shouldBlock;
|
|
1209
|
+
if (basename === "/") return shouldBlock(arg);
|
|
1210
|
+
let { currentLocation, nextLocation, historyAction } = arg;
|
|
1211
|
+
return shouldBlock({
|
|
1212
|
+
currentLocation: {
|
|
1213
|
+
...currentLocation,
|
|
1214
|
+
pathname: stripBasename(currentLocation.pathname, basename) || currentLocation.pathname
|
|
1215
|
+
},
|
|
1216
|
+
nextLocation: {
|
|
1217
|
+
...nextLocation,
|
|
1218
|
+
pathname: stripBasename(nextLocation.pathname, basename) || nextLocation.pathname
|
|
1219
|
+
},
|
|
1220
|
+
historyAction
|
|
1221
|
+
});
|
|
1222
|
+
}, [basename, shouldBlock]);
|
|
1223
|
+
React$1.useEffect(() => {
|
|
1224
|
+
let key = String(++blockerId);
|
|
1225
|
+
setBlockerKey(key);
|
|
1226
|
+
return () => router.deleteBlocker(key);
|
|
1227
|
+
}, [router]);
|
|
1228
|
+
React$1.useEffect(() => {
|
|
1229
|
+
if (blockerKey !== "") router.getBlocker(blockerKey, blockerFunction);
|
|
1230
|
+
}, [
|
|
1231
|
+
router,
|
|
1232
|
+
blockerKey,
|
|
1233
|
+
blockerFunction
|
|
1234
|
+
]);
|
|
1235
|
+
return blockerKey && state.blockers.has(blockerKey) ? state.blockers.get(blockerKey) : IDLE_BLOCKER;
|
|
1236
|
+
}
|
|
1237
|
+
function useNavigateStable() {
|
|
1238
|
+
let { router } = useDataRouterContext("useNavigate");
|
|
1239
|
+
let id = useCurrentRouteId("useNavigate");
|
|
1240
|
+
let activeRef = React$1.useRef(false);
|
|
1241
|
+
React$1.useLayoutEffect(() => {
|
|
1242
|
+
activeRef.current = true;
|
|
1243
|
+
});
|
|
1244
|
+
return React$1.useCallback(async (to, options = {}) => {
|
|
1245
|
+
warning(activeRef.current, navigateEffectWarning);
|
|
1246
|
+
if (!activeRef.current) return;
|
|
1247
|
+
if (typeof to === "number") await router.navigate(to);
|
|
1248
|
+
else await router.navigate(to, {
|
|
1249
|
+
fromRouteId: id,
|
|
1250
|
+
...options
|
|
1251
|
+
});
|
|
1252
|
+
}, [router, id]);
|
|
1253
|
+
}
|
|
1254
|
+
const alreadyWarned = {};
|
|
1255
|
+
function warningOnce(key, cond, message) {
|
|
1256
|
+
if (!cond && !alreadyWarned[key]) {
|
|
1257
|
+
alreadyWarned[key] = true;
|
|
1258
|
+
warning(false, message);
|
|
1259
|
+
}
|
|
1260
|
+
}
|
|
1261
|
+
function useRoute(...args) {
|
|
1262
|
+
const currentRouteId = useCurrentRouteId("useRoute");
|
|
1263
|
+
const id = args[0] ?? currentRouteId;
|
|
1264
|
+
const state = useDataRouterState("useRoute");
|
|
1265
|
+
const route = state.matches.find(({ route }) => route.id === id);
|
|
1266
|
+
if (route === void 0) return void 0;
|
|
1267
|
+
return {
|
|
1268
|
+
handle: route.route.handle,
|
|
1269
|
+
loaderData: state.loaderData[id],
|
|
1270
|
+
actionData: state.actionData?.[id]
|
|
1271
|
+
};
|
|
1272
|
+
}
|
|
1273
|
+
function toRouterStateMatch(match) {
|
|
1274
|
+
return {
|
|
1275
|
+
id: match.route.id,
|
|
1276
|
+
pathname: match.pathname,
|
|
1277
|
+
params: match.params,
|
|
1278
|
+
handle: match.route.handle
|
|
1279
|
+
};
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* A unified hook for reading router state: current (`active`) and in-flight
|
|
1283
|
+
* (`pending`) locations, search params, params, matches, and navigation type.
|
|
1284
|
+
*
|
|
1285
|
+
* This hook consolidates the information you used to get from {@link useLocation},
|
|
1286
|
+
* {@link useSearchParams}, {@link useParams}, {@link useMatches}, {@link useNavigation},
|
|
1287
|
+
* and {@link useNavigationType} into a single hook.
|
|
1288
|
+
*
|
|
1289
|
+
*
|
|
1290
|
+
* @example
|
|
1291
|
+
* import { unstable_useRouterState as useRouterState } from "react-router";
|
|
1292
|
+
*
|
|
1293
|
+
* let { active, pending } = unstable_useRouterState();
|
|
1294
|
+
*
|
|
1295
|
+
* // Active is always populated with the current location
|
|
1296
|
+
* active.location; // replaces `useLocation()`
|
|
1297
|
+
* active.searchParams; // replaces `useSearchParams()[0]`
|
|
1298
|
+
* active.params; // replaces `useParams()`
|
|
1299
|
+
* active.matches; // replaces `useMatches()`
|
|
1300
|
+
* active.type; // replaces `useNavigationType()`
|
|
1301
|
+
*
|
|
1302
|
+
* // Pending is only populated during a navigation
|
|
1303
|
+
* pending.location; // replaces `useNavigation().location`
|
|
1304
|
+
* pending.searchParams; // equivalent to `new URLSearchParams(useNavigation().search)`
|
|
1305
|
+
* pending.params; // Not directly accessible today
|
|
1306
|
+
* pending.matches; // Not directly accessible today
|
|
1307
|
+
* pending.type; // Not directly accessible today
|
|
1308
|
+
* pending.state; // replaces `useNavigation().state`
|
|
1309
|
+
* pending.formMethod; // replaces useNavigation().formMethod
|
|
1310
|
+
* pending.formAction; // replaces useNavigation().formAction
|
|
1311
|
+
* pending.formEncType; // replaces useNavigation().formEncType
|
|
1312
|
+
* pending.formData; // replaces useNavigation().formData
|
|
1313
|
+
* pending.json; // replaces useNavigation().json
|
|
1314
|
+
* pending.text; // replaces useNavigation().text
|
|
1315
|
+
*
|
|
1316
|
+
* @name unstable_useRouterState
|
|
1317
|
+
* @public
|
|
1318
|
+
* @category Hooks
|
|
1319
|
+
* @mode framework
|
|
1320
|
+
* @mode data
|
|
1321
|
+
* @returns The current router state with `active` and `pending` variants
|
|
1322
|
+
*/
|
|
1323
|
+
function useRouterState() {
|
|
1324
|
+
let { location, historyAction: type, matches, navigation } = useDataRouterState("unstable_useRouterState");
|
|
1325
|
+
let active = React$1.useMemo(() => ({
|
|
1326
|
+
type,
|
|
1327
|
+
location,
|
|
1328
|
+
searchParams: new URLSearchParams(location.search),
|
|
1329
|
+
params: matches[matches.length - 1]?.params ?? {},
|
|
1330
|
+
matches: matches.map((m) => toRouterStateMatch(m))
|
|
1331
|
+
}), [
|
|
1332
|
+
location,
|
|
1333
|
+
matches,
|
|
1334
|
+
type
|
|
1335
|
+
]);
|
|
1336
|
+
let pending = React$1.useMemo(() => {
|
|
1337
|
+
if (navigation.state === "idle") return null;
|
|
1338
|
+
let shared = {
|
|
1339
|
+
type: navigation.historyAction,
|
|
1340
|
+
location: navigation.location,
|
|
1341
|
+
searchParams: new URLSearchParams(navigation.location.search),
|
|
1342
|
+
params: navigation.matches[navigation.matches.length - 1]?.params ?? {},
|
|
1343
|
+
matches: navigation.matches.map((m) => toRouterStateMatch(m))
|
|
1344
|
+
};
|
|
1345
|
+
return navigation.state === "loading" ? {
|
|
1346
|
+
...shared,
|
|
1347
|
+
state: "loading",
|
|
1348
|
+
formMethod: navigation.formMethod,
|
|
1349
|
+
formAction: navigation.formAction,
|
|
1350
|
+
formEncType: navigation.formEncType,
|
|
1351
|
+
formData: navigation.formData,
|
|
1352
|
+
json: navigation.json,
|
|
1353
|
+
text: navigation.text
|
|
1354
|
+
} : {
|
|
1355
|
+
...shared,
|
|
1356
|
+
state: "submitting",
|
|
1357
|
+
formMethod: navigation.formMethod,
|
|
1358
|
+
formAction: navigation.formAction,
|
|
1359
|
+
formEncType: navigation.formEncType,
|
|
1360
|
+
formData: navigation.formData,
|
|
1361
|
+
json: navigation.json,
|
|
1362
|
+
text: navigation.text
|
|
1363
|
+
};
|
|
1364
|
+
}, [navigation]);
|
|
1365
|
+
return React$1.useMemo(() => ({
|
|
1366
|
+
active,
|
|
1367
|
+
pending
|
|
1368
|
+
}), [active, pending]);
|
|
1369
|
+
}
|
|
1370
|
+
//#endregion
|
|
1371
|
+
export { _renderMatches, useActionData, useAsyncError, useAsyncValue, useBlocker, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRoute, useRouteError, useRouteId, useRouteLoaderData, useRouterState, useRoutes, useRoutesImpl };
|