diff --git a/docs/api/framework-conventions/react-router.config.ts.md b/docs/api/framework-conventions/react-router.config.ts.md index e5d096bd9f..8e2b3f9395 100644 --- a/docs/api/framework-conventions/react-router.config.ts.md +++ b/docs/api/framework-conventions/react-router.config.ts.md @@ -13,7 +13,7 @@ order: 3 This file is optional -[Reference Documentation ↗](https://api.reactrouter.com/v7/types/_react_router_dev.config.Config.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/types/_react-router_dev.config.Config.html) React Router framework configuration file that lets you customize aspects of your React Router application like server-side rendering, directory locations, and build settings. diff --git a/docs/api/framework-conventions/routes.ts.md b/docs/api/framework-conventions/routes.ts.md index ccac795d3d..94ba02eef9 100644 --- a/docs/api/framework-conventions/routes.ts.md +++ b/docs/api/framework-conventions/routes.ts.md @@ -13,7 +13,7 @@ order: 2 This file is required -[Reference Documentation ↗](https://api.reactrouter.com/v7/interfaces/_react_router_dev.routes.RouteConfigEntry.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/interfaces/_react-router_dev.routes.RouteConfigEntry.html) Configuration file that maps URL patterns to route modules in your application. @@ -59,9 +59,9 @@ export default flatRoutes() satisfies RouteConfig; ### Route Helpers [routing]: ../../start/framework/routing -[route]: https://api.reactrouter.com/v7/functions/_react_router_dev.routes.route.html -[index]: https://api.reactrouter.com/v7/functions/_react_router_dev.routes.index.html -[layout]: https://api.reactrouter.com/v7/functions/_react_router_dev.routes.layout.html -[prefix]: https://api.reactrouter.com/v7/functions/_react_router_dev.routes.prefix.html -[relative]: https://api.reactrouter.com/v7/functions/_react_router_dev.routes.relative.html +[route]: https://api.reactrouter.com/v7/functions/_react-router_dev.routes.route.html +[index]: https://api.reactrouter.com/v7/functions/_react-router_dev.routes.index.html +[layout]: https://api.reactrouter.com/v7/functions/_react-router_dev.routes.layout.html +[prefix]: https://api.reactrouter.com/v7/functions/_react-router_dev.routes.prefix.html +[relative]: https://api.reactrouter.com/v7/functions/_react-router_dev.routes.relative.html [file-route-conventions]: ../../how-to/file-route-conventions diff --git a/docs/api/other-api/adapter.md b/docs/api/other-api/adapter.md index b69469f535..ce95b9db83 100644 --- a/docs/api/other-api/adapter.md +++ b/docs/api/other-api/adapter.md @@ -22,7 +22,7 @@ Each adapter has the same API. In the future, we may have helpers specific to th ## `@react-router/express` -[Reference Documentation ↗](https://api.reactrouter.com/v7/modules/_react_router_express.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/modules/_react-router_express.html) Here's an example with [Express][express]: @@ -122,7 +122,7 @@ Update the `dev` and `start` scripts to use your new Express server: ## `@react-router/cloudflare` -[Reference Documentation ↗](https://api.reactrouter.com/v7/modules/_react_router_cloudflare.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/modules/_react-router_cloudflare.html) Here's an example with Cloudflare: @@ -156,7 +156,7 @@ export default { While not a direct "adapter" like the above, this package contains utilities for working with Node-based adapters. -[Reference Documentation ↗](https://api.reactrouter.com/v7/modules/_react_router_node.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/modules/_react-router_node.html) ### Node Version Support diff --git a/docs/api/utils/IsCookieFunction.md b/docs/api/utils/IsCookieFunction.md index 32e3659316..5157a6d164 100644 --- a/docs/api/utils/IsCookieFunction.md +++ b/docs/api/utils/IsCookieFunction.md @@ -8,4 +8,4 @@ title: IsCookieFunction ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.IsCookieFunction.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.IsCookieFunction.html) diff --git a/docs/api/utils/IsSessionFunction.md b/docs/api/utils/IsSessionFunction.md index 8881b75f5f..bf3321cfe5 100644 --- a/docs/api/utils/IsSessionFunction.md +++ b/docs/api/utils/IsSessionFunction.md @@ -8,4 +8,4 @@ title: IsSessionFunction ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.IsSessionFunction.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.IsSessionFunction.html) diff --git a/docs/api/utils/createCookie.md b/docs/api/utils/createCookie.md index 05c8daa481..593dd558d9 100644 --- a/docs/api/utils/createCookie.md +++ b/docs/api/utils/createCookie.md @@ -8,6 +8,6 @@ title: createCookie ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createCookie.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createCookie.html) Creates a logical container for managing a browser cookie from the server. diff --git a/docs/api/utils/createCookieSessionStorage.md b/docs/api/utils/createCookieSessionStorage.md index 6ffb53047f..83828fd1f4 100644 --- a/docs/api/utils/createCookieSessionStorage.md +++ b/docs/api/utils/createCookieSessionStorage.md @@ -8,7 +8,7 @@ title: createCookieSessionStorage ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createCookieSessionStorage.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createCookieSessionStorage.html) Creates and returns a SessionStorage object that stores all session data directly in the session cookie itself. diff --git a/docs/api/utils/createMemorySessionStorage.md b/docs/api/utils/createMemorySessionStorage.md index 000d63d179..8d916894da 100644 --- a/docs/api/utils/createMemorySessionStorage.md +++ b/docs/api/utils/createMemorySessionStorage.md @@ -8,7 +8,7 @@ title: createMemorySessionStorage ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createMemorySessionStorage.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createMemorySessionStorage.html) Creates and returns a simple in-memory SessionStorage object, mostly useful for testing and as a reference implementation. diff --git a/docs/api/utils/createPath.md b/docs/api/utils/createPath.md index b01f2991a9..195141563d 100644 --- a/docs/api/utils/createPath.md +++ b/docs/api/utils/createPath.md @@ -8,12 +8,10 @@ title: createPath ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createPath.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createPath.html) Creates a string URL path from the given pathname, search, and hash components. - - ## Signature ```tsx @@ -22,9 +20,8 @@ createPath(__namedParameters): string ## Params -### __namedParameters +### \_\_namedParameters [modes: framework, data, declarative] _No documentation_ - diff --git a/docs/api/utils/createRequestHandler.md b/docs/api/utils/createRequestHandler.md index 185d71b568..b85ba28ec5 100644 --- a/docs/api/utils/createRequestHandler.md +++ b/docs/api/utils/createRequestHandler.md @@ -9,5 +9,4 @@ hidden: true ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createRequestHandler.html) - +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createRequestHandler.html) diff --git a/docs/api/utils/createRoutesStub.md b/docs/api/utils/createRoutesStub.md index 82af4e4621..e707fb6555 100644 --- a/docs/api/utils/createRoutesStub.md +++ b/docs/api/utils/createRoutesStub.md @@ -8,7 +8,7 @@ title: createRoutesStub ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createRoutesStub.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createRoutesStub.html) ## Signature diff --git a/docs/api/utils/createSearchParams.md b/docs/api/utils/createSearchParams.md index 5a3bc1a303..b0603e8f5e 100644 --- a/docs/api/utils/createSearchParams.md +++ b/docs/api/utils/createSearchParams.md @@ -8,7 +8,7 @@ title: createSearchParams ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createSearchParams.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createSearchParams.html) Creates a URLSearchParams object using the given initializer. diff --git a/docs/api/utils/createSession.md b/docs/api/utils/createSession.md index 2f52eb9715..37d738b705 100644 --- a/docs/api/utils/createSession.md +++ b/docs/api/utils/createSession.md @@ -9,12 +9,9 @@ hidden: true ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createSession.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createSession.html) Creates a new Session object. Note: This function is typically not invoked directly by application code. Instead, use a `SessionStorage` object's `getSession` method. - - - diff --git a/docs/api/utils/createSessionStorage.md b/docs/api/utils/createSessionStorage.md index 828c01b82b..29a1b62352 100644 --- a/docs/api/utils/createSessionStorage.md +++ b/docs/api/utils/createSessionStorage.md @@ -9,12 +9,9 @@ hidden: true ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createSessionStorage.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.createSessionStorage.html) Creates a SessionStorage object using a SessionIdStorageStrategy. Note: This is a low-level API that should only be used if none of the existing session storage options meet your requirements. - - - diff --git a/docs/api/utils/href.md b/docs/api/utils/href.md index 2c5853f1c4..031d0abbf0 100644 --- a/docs/api/utils/href.md +++ b/docs/api/utils/href.md @@ -8,7 +8,7 @@ title: href ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.href.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.href.html) Returns a resolved URL path for the specified route. diff --git a/docs/api/utils/isCookie.md b/docs/api/utils/isCookie.md index 9e572d0dab..ac0f3b3f32 100644 --- a/docs/api/utils/isCookie.md +++ b/docs/api/utils/isCookie.md @@ -8,6 +8,6 @@ title: isCookie ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.isCookie.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.isCookie.html) Returns true if an object is a Remix cookie container. diff --git a/docs/api/utils/isSession.md b/docs/api/utils/isSession.md index bc819f6fe4..ebac237abc 100644 --- a/docs/api/utils/isSession.md +++ b/docs/api/utils/isSession.md @@ -8,6 +8,6 @@ title: isSession ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.isSession.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.isSession.html) Returns true if an object is a React Router session. diff --git a/docs/api/utils/parsePath.md b/docs/api/utils/parsePath.md index a35bf140c4..bb1c485cfe 100644 --- a/docs/api/utils/parsePath.md +++ b/docs/api/utils/parsePath.md @@ -8,7 +8,7 @@ title: parsePath ## Summary -[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.parsePath.html) +[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react-router.parsePath.html) Parses a string URL path into its separate pathname, search, and hash components. diff --git a/docs/explanation/sessions-and-cookies.md b/docs/explanation/sessions-and-cookies.md index 8d82dd7d11..9beeb33a09 100644 --- a/docs/explanation/sessions-and-cookies.md +++ b/docs/explanation/sessions-and-cookies.md @@ -449,17 +449,17 @@ To learn more about each attribute, please see the [MDN Set-Cookie docs][cookie- [csrf]: https://developer.mozilla.org/en-US/docs/Glossary/CSRF [cookies]: #cookies [sessions]: #sessions -[session-storage]: https://api.reactrouter.com/v7/interfaces/react_router.SessionStorage -[session-api]: https://api.reactrouter.com/v7/interfaces/react_router.Session -[is-session]: https://api.reactrouter.com/v7/functions/react_router.isSession -[cookie-api]: https://api.reactrouter.com/v7/interfaces/react_router.Cookie -[create-session-storage]: https://api.reactrouter.com/v7/functions/react_router.createSessionStorage -[create-session]: https://api.reactrouter.com/v7/functions/react_router.createSession -[create-memory-session-storage]: https://api.reactrouter.com/v7/functions/react_router.createMemorySessionStorage -[create-file-session-storage]: https://api.reactrouter.com/v7/functions/_react_router_node.createFileSessionStorage -[create-workers-kv-session-storage]: https://api.reactrouter.com/v7/functions/_react_router_cloudflare.createWorkersKVSessionStorage -[create-arc-table-session-storage]: https://api.reactrouter.com/v7/functions/_react_router_architect.createArcTableSessionStorage +[session-storage]: https://api.reactrouter.com/v7/interfaces/react-router.SessionStorage +[session-api]: https://api.reactrouter.com/v7/interfaces/react-router.Session +[is-session]: https://api.reactrouter.com/v7/functions/react-router.isSession +[cookie-api]: https://api.reactrouter.com/v7/interfaces/react-router.Cookie +[create-session-storage]: https://api.reactrouter.com/v7/functions/react-router.createSessionStorage +[create-session]: https://api.reactrouter.com/v7/functions/react-router.createSession +[create-memory-session-storage]: https://api.reactrouter.com/v7/functions/react-router.createMemorySessionStorage +[create-file-session-storage]: https://api.reactrouter.com/v7/functions/_react-router_node.createFileSessionStorage +[create-workers-kv-session-storage]: https://api.reactrouter.com/v7/functions/_react-router_cloudflare.createWorkersKVSessionStorage +[create-arc-table-session-storage]: https://api.reactrouter.com/v7/functions/_react-router_architect.createArcTableSessionStorage [cookie]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies [cookie-attrs]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes -[is-cookie]: https://api.reactrouter.com/v7/functions/react_router.isCookie -[create-cookie]: https://api.reactrouter.com/v7/functions/react_router.createCookie +[is-cookie]: https://api.reactrouter.com/v7/functions/react-router.isCookie +[create-cookie]: https://api.reactrouter.com/v7/functions/react-router.createCookie diff --git a/docs/explanation/state-management.md b/docs/explanation/state-management.md index ae1284c775..9c69f14089 100644 --- a/docs/explanation/state-management.md +++ b/docs/explanation/state-management.md @@ -507,8 +507,8 @@ As bonus party trick, the form is functional even before JavaScript loads (see [ If you ever find yourself entangled in managing and synchronizing state for network operations, React Router likely offers a more elegant solution. -[use_navigation]: https://api.reactrouter.com/v7/functions/react_router.useNavigation -[use_fetcher]: https://api.reactrouter.com/v7/functions/react_router.useFetcher +[use_navigation]: https://api.reactrouter.com/v7/functions/react-router.useNavigation +[use_fetcher]: https://api.reactrouter.com/v7/functions/react-router.useFetcher [loader_data]: ../start/framework/data-loading [action_data]: ../start/framework/actions [cookies]: ./sessions-and-cookies#cookies diff --git a/docs/how-to/presets.md b/docs/how-to/presets.md index 100b34d7d2..febf65418c 100644 --- a/docs/how-to/presets.md +++ b/docs/how-to/presets.md @@ -98,6 +98,6 @@ export default { } satisfies Config; ``` -[react-router-config]: https://api.reactrouter.com/v7/types/_react_router_dev.config.Config.html -[preset-type]: https://api.reactrouter.com/v7/types/_react_router_dev.config.Preset.html +[react-router-config]: https://api.reactrouter.com/v7/types/_react-router_dev.config.Config.html +[preset-type]: https://api.reactrouter.com/v7/types/_react-router_dev.config.Preset.html [server-bundles]: ./server-bundles diff --git a/docs/how-to/server-bundles.md b/docs/how-to/server-bundles.md index 2f03c214a0..7c4a3a09db 100644 --- a/docs/how-to/server-bundles.md +++ b/docs/how-to/server-bundles.md @@ -62,5 +62,5 @@ When using server bundles, the build manifest contains the following properties: - `routeIdToServerBundleId` — An object that maps route IDs to their server bundle ID - `routes` — A route manifest that maps route IDs to route metadata. This can be used to drive a custom routing layer in front of your React Router request handlers -[react-router-config]: https://api.reactrouter.com/v7/types/_react_router_dev.config.Config.html -[server-bundles-function]: https://api.reactrouter.com/v7/types/_react_router_dev.config.ServerBundlesFunction.html +[react-router-config]: https://api.reactrouter.com/v7/types/_react-router_dev.config.Config.html +[server-bundles-function]: https://api.reactrouter.com/v7/types/_react-router_dev.config.ServerBundlesFunction.html diff --git a/docs/index.md b/docs/index.md index 0ab5c09c02..6ed4d9e026 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ These icons indicate which mode the content is relevant to. Additional auto-generated reference documentation is available: -[Autogenerated Reference Docs ↗](https://api.reactrouter.com/v7/modules/react_router.html) +[Autogenerated Reference Docs ↗](https://api.reactrouter.com/v7/) ## Upgrading diff --git a/docs/start/data/route-object.md b/docs/start/data/route-object.md index 40a8896fdb..b55817cbbc 100644 --- a/docs/start/data/route-object.md +++ b/docs/start/data/route-object.md @@ -216,7 +216,7 @@ createBrowserRouter([ ]); ``` -[`ShouldRevalidateFunctionArgs` Reference Documentation ↗](https://api.reactrouter.com/v7/interfaces/react_router.ShouldRevalidateFunctionArgs.html) +[`ShouldRevalidateFunctionArgs` Reference Documentation ↗](https://api.reactrouter.com/v7/interfaces/react-router.ShouldRevalidateFunctionArgs.html) Please note the default behavior is different in [Framework Mode](../modes). @@ -244,5 +244,5 @@ createBrowserRouter([ Next: [Data Loading](./data-loading) -[loader-params]: https://api.reactrouter.com/v7/interfaces/react_router.LoaderFunctionArgs +[loader-params]: https://api.reactrouter.com/v7/interfaces/react-router.LoaderFunctionArgs [middleware]: ../../how-to/middleware diff --git a/docs/start/data/routing.md b/docs/start/data/routing.md index 10a1fa82fc..5365a14425 100644 --- a/docs/start/data/routing.md +++ b/docs/start/data/routing.md @@ -278,4 +278,4 @@ const { "*": splat } = params; Next: [Route Object](./route-object) -[outlet]: https://api.reactrouter.com/v7/functions/react_router.Outlet.html +[outlet]: https://api.reactrouter.com/v7/functions/react-router.Outlet.html diff --git a/docs/start/framework/pending-ui.md b/docs/start/framework/pending-ui.md index d68568e0bd..24e107397f 100644 --- a/docs/start/framework/pending-ui.md +++ b/docs/start/framework/pending-ui.md @@ -139,4 +139,4 @@ function Task({ task }) { Next: [Testing](./testing) -[use_fetcher]: https://api.reactrouter.com/v7/functions/react_router.useFetcher.html +[use_fetcher]: https://api.reactrouter.com/v7/functions/react-router.useFetcher.html diff --git a/docs/start/framework/route-module.md b/docs/start/framework/route-module.md index 5e00b48b87..8bc17cbf5e 100644 --- a/docs/start/framework/route-module.md +++ b/docs/start/framework/route-module.md @@ -496,27 +496,27 @@ export function shouldRevalidate( When using [SPA Mode][spa-mode], there are no server loaders to call on navigations, so `shouldRevalidate` behaves the same as it does in [Data Mode][data-mode-should-revalidate]. -[`ShouldRevalidateFunctionArgs` Reference Documentation ↗](https://api.reactrouter.com/v7/interfaces/react_router.ShouldRevalidateFunctionArgs.html) +[`ShouldRevalidateFunctionArgs` Reference Documentation ↗](https://api.reactrouter.com/v7/interfaces/react-router.ShouldRevalidateFunctionArgs.html) --- Next: [Rendering Strategies](./rendering) -[middleware-params]: https://api.reactrouter.com/v7/types/react_router.MiddlewareFunction.html +[middleware-params]: https://api.reactrouter.com/v7/types/react-router.MiddlewareFunction.html [middleware]: ../../how-to/middleware [when-middleware-runs]: ../../how-to/middleware#when-middleware-runs -[loader-params]: https://api.reactrouter.com/v7/interfaces/react_router.LoaderFunctionArgs -[client-loader-params]: https://api.reactrouter.com/v7/types/react_router.ClientLoaderFunctionArgs -[action-params]: https://api.reactrouter.com/v7/interfaces/react_router.ActionFunctionArgs -[client-action-params]: https://api.reactrouter.com/v7/types/react_router.ClientActionFunctionArgs +[loader-params]: https://api.reactrouter.com/v7/interfaces/react-router.LoaderFunctionArgs +[client-loader-params]: https://api.reactrouter.com/v7/types/react-router.ClientLoaderFunctionArgs +[action-params]: https://api.reactrouter.com/v7/interfaces/react-router.ActionFunctionArgs +[client-action-params]: https://api.reactrouter.com/v7/types/react-router.ClientActionFunctionArgs [use-route-error]: ../../api/hooks/useRouteError [is-route-error-response]: ../../api/utils/isRouteErrorResponse [headers]: https://developer.mozilla.org/en-US/docs/Web/API/Response/headers [use-matches]: ../../api/hooks/useMatches [link-element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link [meta-element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta -[meta-params]: https://api.reactrouter.com/v7/interfaces/react_router.MetaArgs -[meta-function]: https://api.reactrouter.com/v7/types/react_router.MetaDescriptor.html +[meta-params]: https://api.reactrouter.com/v7/interfaces/react-router.MetaArgs +[meta-function]: https://api.reactrouter.com/v7/types/react-router.MetaDescriptor.html [data-mode-should-revalidate]: ../data/route-object#shouldrevalidate [spa-mode]: ../../how-to/spa [client-data]: ../../how-to/client-data diff --git a/docs/start/framework/routing.md b/docs/start/framework/routing.md index 157ce0c76b..73845a8d63 100644 --- a/docs/start/framework/routing.md +++ b/docs/start/framework/routing.md @@ -359,4 +359,4 @@ Note that these routes do not participate in data loading, actions, code splitti Next: [Route Module](./route-module) [file-route-conventions]: ../../how-to/file-route-conventions -[outlet]: https://api.reactrouter.com/v7/functions/react_router.Outlet.html +[outlet]: https://api.reactrouter.com/v7/functions/react-router.Outlet.html diff --git a/docs/tutorials/address-book.md b/docs/tutorials/address-book.md index b5172451c1..ab450711cb 100644 --- a/docs/tutorials/address-book.md +++ b/docs/tutorials/address-book.md @@ -1942,10 +1942,10 @@ That's it! Thanks for giving React Router a shot. We hope this tutorial gives yo [root-route]: ../explanation/special-files#roottsx [error-boundaries]: ../how-to/error-boundary [links]: ../start/framework/route-module#links -[outlet-component]: https://api.reactrouter.com/v7/functions/react_router.Outlet +[outlet-component]: https://api.reactrouter.com/v7/functions/react-router.Outlet [file-route-conventions]: ../how-to/file-route-conventions [contacts-1]: http://localhost:5173/contacts/1 -[link-component]: https://api.reactrouter.com/v7/functions/react_router.Link +[link-component]: https://api.reactrouter.com/v7/functions/react-router.Link [client-loader]: ../start/framework/route-module#clientloader [spa]: ../how-to/spa [type-safety]: ../explanation/type-safety @@ -1959,17 +1959,17 @@ That's it! Thanks for giving React Router a shot. We hope this tutorial gives yo [url-search-params]: https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams [loader]: ../start/framework/route-module#loader [action]: ../start/framework/route-module#action -[form-component]: https://api.reactrouter.com/v7/functions/react_router.Form +[form-component]: https://api.reactrouter.com/v7/functions/react-router.Form [fetch]: https://developer.mozilla.org/en-US/docs/Web/API/fetch [form-data]: https://developer.mozilla.org/en-US/docs/Web/API/FormData [object-from-entries]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/fromEntries [request-form-data]: https://developer.mozilla.org/en-US/docs/Web/API/Request/formData [request]: https://developer.mozilla.org/en-US/docs/Web/API/Request -[redirect]: https://api.reactrouter.com/v7/functions/react_router.redirect +[redirect]: https://api.reactrouter.com/v7/functions/react-router.redirect [response]: https://developer.mozilla.org/en-US/docs/Web/API/Response -[nav-link]: https://api.reactrouter.com/v7/functions/react_router.NavLink -[use-navigation]: https://api.reactrouter.com/v7/functions/react_router.useNavigation -[use-navigate]: https://api.reactrouter.com/v7/functions/react_router.useNavigate -[use-submit]: https://api.reactrouter.com/v7/functions/react_router.useSubmit -[use-fetcher]: https://api.reactrouter.com/v7/functions/react_router.useFetcher +[nav-link]: https://api.reactrouter.com/v7/functions/react-router.NavLink +[use-navigation]: https://api.reactrouter.com/v7/functions/react-router.useNavigation +[use-navigate]: https://api.reactrouter.com/v7/functions/react-router.useNavigate +[use-submit]: https://api.reactrouter.com/v7/functions/react-router.useSubmit +[use-fetcher]: https://api.reactrouter.com/v7/functions/react-router.useFetcher [react-router-apis]: https://api.reactrouter.com/v7/modules/react_router diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md index 5872a754e6..915e27086a 100644 --- a/docs/tutorials/quickstart.md +++ b/docs/tutorials/quickstart.md @@ -294,7 +294,7 @@ What's next? [routing]: ../start/framework/routing [http-localhost-3000]: http://localhost:3000 [vite]: https://vitejs.dev -[react-router-config]: https://api.reactrouter.com/v7/types/_react_router_dev.config.Config.html +[react-router-config]: https://api.reactrouter.com/v7/types/_react-router_dev.config.Config.html [vite-middleware]: https://vitejs.dev/guide/ssr#setting-up-the-dev-server [cross-env]: https://www.npmjs.com/package/cross-env [address-book-tutorial]: ./address-book diff --git a/docs/upgrading/v6.md b/docs/upgrading/v6.md index ce6102d18f..0118c66898 100644 --- a/docs/upgrading/v6.md +++ b/docs/upgrading/v6.md @@ -376,4 +376,4 @@ Congratulations, you're now on v7! [react-flushsync]: https://react.dev/reference/react-dom/flushSync [response-json]: https://developer.mozilla.org/en-US/docs/Web/API/Response/json -[data-util]: https://api.reactrouter.com/v7/functions/react_router.data.html +[data-util]: https://api.reactrouter.com/v7/functions/react-router.data.html diff --git a/packages/react-router-node/sessions/fileStorage.ts b/packages/react-router-node/sessions/fileStorage.ts index 840d463a5f..12717dda5f 100644 --- a/packages/react-router-node/sessions/fileStorage.ts +++ b/packages/react-router-node/sessions/fileStorage.ts @@ -26,7 +26,7 @@ interface FileSessionStorageOptions { * The advantage of using this instead of cookie session storage is that * files may contain much more data than cookies. * - * @see https://api.reactrouter.com/v7/functions/_react_router_node.createFileSessionStorage + * @see https://api.reactrouter.com/v7/functions/_react-router_node.createFileSessionStorage */ export function createFileSessionStorage({ cookie, diff --git a/packages/react-router/lib/context.ts b/packages/react-router/lib/context.ts index 60d1c4e178..451e71b2d8 100644 --- a/packages/react-router/lib/context.ts +++ b/packages/react-router/lib/context.ts @@ -147,13 +147,13 @@ export interface NavigateOptions { replace?: boolean; /** Adds persistent client side routing state to the next location */ state?: any; - /** If you are using {@link https://api.reactrouter.com/v7/functions/react_router.ScrollRestoration.html }, prevent the scroll position from being reset to the top of the window when navigating */ + /** If you are using {@link ScrollRestoration ``}, prevent the scroll position from being reset to the top of the window when navigating */ preventScrollReset?: boolean; /** Defines the relative path behavior for the link. "route" will use the route hierarchy so ".." will remove all URL segments of the current route pattern while "path" will use the URL path so ".." will remove one URL segment. */ relative?: RelativeRoutingType; /** Wraps the initial state update for this navigation in a {@link https://react.dev/reference/react-dom/flushSync ReactDOM.flushSync} call instead of the default {@link https://react.dev/reference/react/startTransition React.startTransition} */ flushSync?: boolean; - /** Enables a {@link https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API View Transition} for this navigation by wrapping the final state update in `document.startViewTransition()`. If you need to apply specific styles for this view transition, you will also need to leverage the {@link https://api.reactrouter.com/v7/functions/react_router.useViewTransitionState.html useViewTransitionState()} hook. */ + /** Enables a {@link https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API View Transition} for this navigation by wrapping the final state update in `document.startViewTransition()`. If you need to apply specific styles for this view transition, you will also need to leverage the {@link useViewTransitionState `useViewTransitionState()`} hook. */ viewTransition?: boolean; /** Specifies the default revalidation behavior after this submission */ unstable_defaultShouldRevalidate?: boolean; diff --git a/packages/react-router/lib/types/route-module-annotations.ts b/packages/react-router/lib/types/route-module-annotations.ts index 30ba7c983e..1eedc837a3 100644 --- a/packages/react-router/lib/types/route-module-annotations.ts +++ b/packages/react-router/lib/types/route-module-annotations.ts @@ -76,7 +76,7 @@ type CreateMetaArgs = { | (HasErrorBoundary extends true ? undefined : never); /** Thrown errors that trigger error boundaries will be passed to the meta function. This is useful for generating metadata for error pages. */ error?: unknown; - /** An array of the current {@link https://api.reactrouter.com/v7/interfaces/react_router.UIMatch.html route matches}, including parent route matches. */ + /** An array of the current {@link https://api.reactrouter.com/v7/interfaces/react-router.UIMatch.html route matches}, including parent route matches. */ matches: MetaMatches; }; type MetaDescriptors = MetaDescriptor[]; @@ -180,7 +180,7 @@ type CreateComponentProps = { * } **/ params: T["params"]; - /** An array of the current {@link https://api.reactrouter.com/v7/interfaces/react_router.UIMatch.html route matches}, including parent route matches. */ + /** An array of the current {@link https://api.reactrouter.com/v7/interfaces/react-router.UIMatch.html route matches}, including parent route matches. */ matches: Matches; } & (IsServerFirstRoute extends true ? {