Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/router/eslint/eslint-plugin-router.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Alternatively, add `@tanstack/eslint-plugin-router` to the plugins section, and

The following rules are available in the TanStack Router ESLint Plugin:

- [@tanstack/router/create-route-property-order](../create-route-property-order.md)
- [@tanstack/router/create-route-property-order](./create-route-property-order.md)

## Conflicts with other ESLint plugins

Expand Down
158 changes: 79 additions & 79 deletions docs/router/framework/react/api/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,86 +4,86 @@ title: Router API
---

- Functions
- [`createFileRoute`](../router/createFileRouteFunction.md)
- [`createLazyFileRoute`](../router/createLazyFileRouteFunction.md)
- [`createRootRoute`](../router/createRootRouteFunction.md)
- [`createRootRouteWithContext`](../router/createRootRouteWithContextFunction.md)
- [`createRoute`](../router/createRouteFunction.md)
- [`createLazyRoute`](../router/createLazyRouteFunction.md)
- [`createRouteMask`](../router/createRouteMaskFunction.md)
- [`createRouter`](../router/createRouterFunction.md)
- [`defer`](../router/deferFunction.md)
- [`getRouteApi`](../router/getRouteApiFunction.md)
- [`isNotFound`](../router/isNotFoundFunction.md)
- [`isRedirect`](../router/isRedirectFunction.md)
- [`lazyRouteComponent`](../router/lazyRouteComponentFunction.md)
- [`linkOptions`](../router/linkOptions.md)
- [`notFound`](../router/notFoundFunction.md)
- [`redirect`](../router/redirectFunction.md)
- [`retainSearchParams`](../router/retainSearchParamsFunction.md)
- [`stripSearchParams`](../router/stripSearchParamsFunction.md)
- [`createFileRoute`](./router/createFileRouteFunction.md)
- [`createLazyFileRoute`](./router/createLazyFileRouteFunction.md)
- [`createRootRoute`](./router/createRootRouteFunction.md)
- [`createRootRouteWithContext`](./router/createRootRouteWithContextFunction.md)
- [`createRoute`](./router/createRouteFunction.md)
- [`createLazyRoute`](./router/createLazyRouteFunction.md)
- [`createRouteMask`](./router/createRouteMaskFunction.md)
- [`createRouter`](./router/createRouterFunction.md)
- [`defer`](./router/deferFunction.md)
- [`getRouteApi`](./router/getRouteApiFunction.md)
- [`isNotFound`](./router/isNotFoundFunction.md)
- [`isRedirect`](./router/isRedirectFunction.md)
- [`lazyRouteComponent`](./router/lazyRouteComponentFunction.md)
- [`linkOptions`](./router/linkOptions.md)
- [`notFound`](./router/notFoundFunction.md)
- [`redirect`](./router/redirectFunction.md)
- [`retainSearchParams`](./router/retainSearchParamsFunction.md)
- [`stripSearchParams`](./router/stripSearchParamsFunction.md)
- Components
- [`<Await>`](../router/awaitComponent.md)
- [`<CatchBoundary>`](../router/catchBoundaryComponent.md)
- [`<CatchNotFound>`](../router/catchNotFoundComponent.md)
- [`<ClientOnly>`](../router/clientOnlyComponent.md)
- [`<DefaultGlobalNotFound>`](../router/defaultGlobalNotFoundComponent.md)
- [`<ErrorComponent>`](../router/errorComponentComponent.md)
- [`<Link>`](../router/linkComponent.md)
- [`<MatchRoute>`](../router/matchRouteComponent.md)
- [`<Navigate>`](../router/navigateComponent.md)
- [`<NotFoundComponent>`](../router/notFoundComponentComponent.md)
- [`<Outlet>`](../router/outletComponent.md)
- [`<Await>`](./router/awaitComponent.md)
- [`<CatchBoundary>`](./router/catchBoundaryComponent.md)
- [`<CatchNotFound>`](./router/catchNotFoundComponent.md)
- [`<ClientOnly>`](./router/clientOnlyComponent.md)
- [`<DefaultGlobalNotFound>`](./router/defaultGlobalNotFoundComponent.md)
- [`<ErrorComponent>`](./router/errorComponentComponent.md)
- [`<Link>`](./router/linkComponent.md)
- [`<MatchRoute>`](./router/matchRouteComponent.md)
- [`<Navigate>`](./router/navigateComponent.md)
- [`<NotFoundComponent>`](./router/notFoundComponentComponent.md)
- [`<Outlet>`](./router/outletComponent.md)
- Hooks
- [`useAwaited`](../router/useAwaitedHook.md)
- [`useBlocker`](../router/useBlockerHook.md)
- [`useCanGoBack`](../router//useCanGoBack.md)
- [`useChildMatches`](../router/useChildMatchesHook.md)
- [`useLinkProps`](../router/useLinkPropsHook.md)
- [`useLoaderData`](../router/useLoaderDataHook.md)
- [`useLoaderDeps`](../router/useLoaderDepsHook.md)
- [`useLocation`](../router/useLocationHook.md)
- [`useMatch`](../router/useMatchHook.md)
- [`useMatchRoute`](../router/useMatchRouteHook.md)
- [`useMatches`](../router/useMatchesHook.md)
- [`useNavigate`](../router/useNavigateHook.md)
- [`useParentMatches`](../router/useParentMatchesHook.md)
- [`useParams`](../router/useParamsHook.md)
- [`useRouteContext`](../router/useRouteContextHook.md)
- [`useRouter`](../router/useRouterHook.md)
- [`useRouterState`](../router/useRouterStateHook.md)
- [`useSearch`](../router/useSearchHook.md)
- [`useAwaited`](./router/useAwaitedHook.md)
- [`useBlocker`](./router/useBlockerHook.md)
- [`useCanGoBack`](./router//useCanGoBack.md)
- [`useChildMatches`](./router/useChildMatchesHook.md)
- [`useLinkProps`](./router/useLinkPropsHook.md)
- [`useLoaderData`](./router/useLoaderDataHook.md)
- [`useLoaderDeps`](./router/useLoaderDepsHook.md)
- [`useLocation`](./router/useLocationHook.md)
- [`useMatch`](./router/useMatchHook.md)
- [`useMatchRoute`](./router/useMatchRouteHook.md)
- [`useMatches`](./router/useMatchesHook.md)
- [`useNavigate`](./router/useNavigateHook.md)
- [`useParentMatches`](./router/useParentMatchesHook.md)
- [`useParams`](./router/useParamsHook.md)
- [`useRouteContext`](./router/useRouteContextHook.md)
- [`useRouter`](./router/useRouterHook.md)
- [`useRouterState`](./router/useRouterStateHook.md)
- [`useSearch`](./router/useSearchHook.md)
- Types
- [`ActiveLinkOptions Type`](../router/ActiveLinkOptionsType.md)
- [`AsyncRouteComponent Type`](../router/AsyncRouteComponentType.md)
- [`HistoryState Interface`](../router/historyStateInterface.md)
- [`LinkOptions Type`](../router/LinkOptionsType.md)
- [`LinkProps Type`](../router/LinkPropsType.md)
- [`MatchRouteOptions Type`](../router/MatchRouteOptionsType.md)
- [`NavigateOptions Type`](../router/NavigateOptionsType.md)
- [`NotFoundError Type`](../router/NotFoundErrorType.md)
- [`ParsedHistoryState Type`](../router/ParsedHistoryStateType.md)
- [`ParsedLocation Type`](../router/ParsedLocationType.md)
- [`Redirect Type`](../router/RedirectType.md)
- [`Register Type`](../router/RegisterType.md)
- [`Route Type`](../router/RouteType.md)
- [`RouteApi Type`](../router/RouteApiType.md)
- [`RouteMask Type`](../router/RouteMaskType.md)
- [`RouteMatch Type`](../router/RouteMatchType.md)
- [`RouteOptions Type`](../router/RouteOptionsType.md)
- [`Router Type`](../router/RouterType.md)
- [`RouterEvents Type`](../router/RouterEventsType.md)
- [`RouterOptions Type`](../router/RouterOptionsType.md)
- [`RouterState Type`](../router/RouterStateType.md)
- [`ToMaskOptions Type`](../router/ToMaskOptionsType.md)
- [`ToOptions Type`](../router/ToOptionsType.md)
- [`UseMatchRouteOptions Type`](../router/UseMatchRouteOptionsType.md)
- [`ViewTransitionOptions Type`](../router/ViewTransitionOptionsType.md)
- [`ActiveLinkOptions Type`](./router/ActiveLinkOptionsType.md)
- [`AsyncRouteComponent Type`](./router/AsyncRouteComponentType.md)
- [`HistoryState Interface`](./router/historyStateInterface.md)
- [`LinkOptions Type`](./router/LinkOptionsType.md)
- [`LinkProps Type`](./router/LinkPropsType.md)
- [`MatchRouteOptions Type`](./router/MatchRouteOptionsType.md)
- [`NavigateOptions Type`](./router/NavigateOptionsType.md)
- [`NotFoundError Type`](./router/NotFoundErrorType.md)
- [`ParsedHistoryState Type`](./router/ParsedHistoryStateType.md)
- [`ParsedLocation Type`](./router/ParsedLocationType.md)
- [`Redirect Type`](./router/RedirectType.md)
- [`Register Type`](./router/RegisterType.md)
- [`Route Type`](./router/RouteType.md)
- [`RouteApi Type`](./router/RouteApiType.md)
- [`RouteMask Type`](./router/RouteMaskType.md)
- [`RouteMatch Type`](./router/RouteMatchType.md)
- [`RouteOptions Type`](./router/RouteOptionsType.md)
- [`Router Type`](./router/RouterType.md)
- [`RouterEvents Type`](./router/RouterEventsType.md)
- [`RouterOptions Type`](./router/RouterOptionsType.md)
- [`RouterState Type`](./router/RouterStateType.md)
- [`ToMaskOptions Type`](./router/ToMaskOptionsType.md)
- [`ToOptions Type`](./router/ToOptionsType.md)
- [`UseMatchRouteOptions Type`](./router/UseMatchRouteOptionsType.md)
- [`ViewTransitionOptions Type`](./router/ViewTransitionOptionsType.md)
- ⚠️ Deprecated
- [`FileRoute Class`](../router/FileRouteClass.md)
- [`Route Class`](../router/RouteClass.md)
- [`Router Class`](../router/RouterClass.md)
- [`RouteApi Class`](../router/RouteApiClass.md)
- [`RootRoute Class`](../router/RootRouteClass.md)
- [`NotFoundRoute Class`](../router/NotFoundRouteClass.md)
- [`rootRouteWithContext Function`](../router/rootRouteWithContextFunction.md)
- [`FileRoute Class`](./router/FileRouteClass.md)
- [`Route Class`](./router/RouteClass.md)
- [`Router Class`](./router/RouterClass.md)
- [`RouteApi Class`](./router/RouteApiClass.md)
- [`RootRoute Class`](./router/RootRouteClass.md)
- [`NotFoundRoute Class`](./router/NotFoundRouteClass.md)
Comment on lines +7 to +88
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix malformed link path on line 40.

Line 40 contains a double slash in the link path: ./router//useCanGoBack.md. This should be corrected to ./router/useCanGoBack.md to maintain consistency and prevent link resolution issues. All other link updates in this file correctly use the ./router/ prefix.

Apply this diff to fix the double slash:

-  - [`useCanGoBack`](./router//useCanGoBack.md)
+  - [`useCanGoBack`](./router/useCanGoBack.md)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [`createFileRoute`](./router/createFileRouteFunction.md)
- [`createLazyFileRoute`](./router/createLazyFileRouteFunction.md)
- [`createRootRoute`](./router/createRootRouteFunction.md)
- [`createRootRouteWithContext`](./router/createRootRouteWithContextFunction.md)
- [`createRoute`](./router/createRouteFunction.md)
- [`createLazyRoute`](./router/createLazyRouteFunction.md)
- [`createRouteMask`](./router/createRouteMaskFunction.md)
- [`createRouter`](./router/createRouterFunction.md)
- [`defer`](./router/deferFunction.md)
- [`getRouteApi`](./router/getRouteApiFunction.md)
- [`isNotFound`](./router/isNotFoundFunction.md)
- [`isRedirect`](./router/isRedirectFunction.md)
- [`lazyRouteComponent`](./router/lazyRouteComponentFunction.md)
- [`linkOptions`](./router/linkOptions.md)
- [`notFound`](./router/notFoundFunction.md)
- [`redirect`](./router/redirectFunction.md)
- [`retainSearchParams`](./router/retainSearchParamsFunction.md)
- [`stripSearchParams`](./router/stripSearchParamsFunction.md)
- Components
- [`<Await>`](../router/awaitComponent.md)
- [`<CatchBoundary>`](../router/catchBoundaryComponent.md)
- [`<CatchNotFound>`](../router/catchNotFoundComponent.md)
- [`<ClientOnly>`](../router/clientOnlyComponent.md)
- [`<DefaultGlobalNotFound>`](../router/defaultGlobalNotFoundComponent.md)
- [`<ErrorComponent>`](../router/errorComponentComponent.md)
- [`<Link>`](../router/linkComponent.md)
- [`<MatchRoute>`](../router/matchRouteComponent.md)
- [`<Navigate>`](../router/navigateComponent.md)
- [`<NotFoundComponent>`](../router/notFoundComponentComponent.md)
- [`<Outlet>`](../router/outletComponent.md)
- [`<Await>`](./router/awaitComponent.md)
- [`<CatchBoundary>`](./router/catchBoundaryComponent.md)
- [`<CatchNotFound>`](./router/catchNotFoundComponent.md)
- [`<ClientOnly>`](./router/clientOnlyComponent.md)
- [`<DefaultGlobalNotFound>`](./router/defaultGlobalNotFoundComponent.md)
- [`<ErrorComponent>`](./router/errorComponentComponent.md)
- [`<Link>`](./router/linkComponent.md)
- [`<MatchRoute>`](./router/matchRouteComponent.md)
- [`<Navigate>`](./router/navigateComponent.md)
- [`<NotFoundComponent>`](./router/notFoundComponentComponent.md)
- [`<Outlet>`](./router/outletComponent.md)
- Hooks
- [`useAwaited`](../router/useAwaitedHook.md)
- [`useBlocker`](../router/useBlockerHook.md)
- [`useCanGoBack`](../router//useCanGoBack.md)
- [`useChildMatches`](../router/useChildMatchesHook.md)
- [`useLinkProps`](../router/useLinkPropsHook.md)
- [`useLoaderData`](../router/useLoaderDataHook.md)
- [`useLoaderDeps`](../router/useLoaderDepsHook.md)
- [`useLocation`](../router/useLocationHook.md)
- [`useMatch`](../router/useMatchHook.md)
- [`useMatchRoute`](../router/useMatchRouteHook.md)
- [`useMatches`](../router/useMatchesHook.md)
- [`useNavigate`](../router/useNavigateHook.md)
- [`useParentMatches`](../router/useParentMatchesHook.md)
- [`useParams`](../router/useParamsHook.md)
- [`useRouteContext`](../router/useRouteContextHook.md)
- [`useRouter`](../router/useRouterHook.md)
- [`useRouterState`](../router/useRouterStateHook.md)
- [`useSearch`](../router/useSearchHook.md)
- [`useAwaited`](./router/useAwaitedHook.md)
- [`useBlocker`](./router/useBlockerHook.md)
- [`useCanGoBack`](./router//useCanGoBack.md)
- [`useChildMatches`](./router/useChildMatchesHook.md)
- [`useLinkProps`](./router/useLinkPropsHook.md)
- [`useLoaderData`](./router/useLoaderDataHook.md)
- [`useLoaderDeps`](./router/useLoaderDepsHook.md)
- [`useLocation`](./router/useLocationHook.md)
- [`useMatch`](./router/useMatchHook.md)
- [`useMatchRoute`](./router/useMatchRouteHook.md)
- [`useMatches`](./router/useMatchesHook.md)
- [`useNavigate`](./router/useNavigateHook.md)
- [`useParentMatches`](./router/useParentMatchesHook.md)
- [`useParams`](./router/useParamsHook.md)
- [`useRouteContext`](./router/useRouteContextHook.md)
- [`useRouter`](./router/useRouterHook.md)
- [`useRouterState`](./router/useRouterStateHook.md)
- [`useSearch`](./router/useSearchHook.md)
- Types
- [`ActiveLinkOptions Type`](../router/ActiveLinkOptionsType.md)
- [`AsyncRouteComponent Type`](../router/AsyncRouteComponentType.md)
- [`HistoryState Interface`](../router/historyStateInterface.md)
- [`LinkOptions Type`](../router/LinkOptionsType.md)
- [`LinkProps Type`](../router/LinkPropsType.md)
- [`MatchRouteOptions Type`](../router/MatchRouteOptionsType.md)
- [`NavigateOptions Type`](../router/NavigateOptionsType.md)
- [`NotFoundError Type`](../router/NotFoundErrorType.md)
- [`ParsedHistoryState Type`](../router/ParsedHistoryStateType.md)
- [`ParsedLocation Type`](../router/ParsedLocationType.md)
- [`Redirect Type`](../router/RedirectType.md)
- [`Register Type`](../router/RegisterType.md)
- [`Route Type`](../router/RouteType.md)
- [`RouteApi Type`](../router/RouteApiType.md)
- [`RouteMask Type`](../router/RouteMaskType.md)
- [`RouteMatch Type`](../router/RouteMatchType.md)
- [`RouteOptions Type`](../router/RouteOptionsType.md)
- [`Router Type`](../router/RouterType.md)
- [`RouterEvents Type`](../router/RouterEventsType.md)
- [`RouterOptions Type`](../router/RouterOptionsType.md)
- [`RouterState Type`](../router/RouterStateType.md)
- [`ToMaskOptions Type`](../router/ToMaskOptionsType.md)
- [`ToOptions Type`](../router/ToOptionsType.md)
- [`UseMatchRouteOptions Type`](../router/UseMatchRouteOptionsType.md)
- [`ViewTransitionOptions Type`](../router/ViewTransitionOptionsType.md)
- [`ActiveLinkOptions Type`](./router/ActiveLinkOptionsType.md)
- [`AsyncRouteComponent Type`](./router/AsyncRouteComponentType.md)
- [`HistoryState Interface`](./router/historyStateInterface.md)
- [`LinkOptions Type`](./router/LinkOptionsType.md)
- [`LinkProps Type`](./router/LinkPropsType.md)
- [`MatchRouteOptions Type`](./router/MatchRouteOptionsType.md)
- [`NavigateOptions Type`](./router/NavigateOptionsType.md)
- [`NotFoundError Type`](./router/NotFoundErrorType.md)
- [`ParsedHistoryState Type`](./router/ParsedHistoryStateType.md)
- [`ParsedLocation Type`](./router/ParsedLocationType.md)
- [`Redirect Type`](./router/RedirectType.md)
- [`Register Type`](./router/RegisterType.md)
- [`Route Type`](./router/RouteType.md)
- [`RouteApi Type`](./router/RouteApiType.md)
- [`RouteMask Type`](./router/RouteMaskType.md)
- [`RouteMatch Type`](./router/RouteMatchType.md)
- [`RouteOptions Type`](./router/RouteOptionsType.md)
- [`Router Type`](./router/RouterType.md)
- [`RouterEvents Type`](./router/RouterEventsType.md)
- [`RouterOptions Type`](./router/RouterOptionsType.md)
- [`RouterState Type`](./router/RouterStateType.md)
- [`ToMaskOptions Type`](./router/ToMaskOptionsType.md)
- [`ToOptions Type`](./router/ToOptionsType.md)
- [`UseMatchRouteOptions Type`](./router/UseMatchRouteOptionsType.md)
- [`ViewTransitionOptions Type`](./router/ViewTransitionOptionsType.md)
- ⚠️ Deprecated
- [`FileRoute Class`](../router/FileRouteClass.md)
- [`Route Class`](../router/RouteClass.md)
- [`Router Class`](../router/RouterClass.md)
- [`RouteApi Class`](../router/RouteApiClass.md)
- [`RootRoute Class`](../router/RootRouteClass.md)
- [`NotFoundRoute Class`](../router/NotFoundRouteClass.md)
- [`rootRouteWithContext Function`](../router/rootRouteWithContextFunction.md)
- [`FileRoute Class`](./router/FileRouteClass.md)
- [`Route Class`](./router/RouteClass.md)
- [`Router Class`](./router/RouterClass.md)
- [`RouteApi Class`](./router/RouteApiClass.md)
- [`RootRoute Class`](./router/RootRouteClass.md)
- [`NotFoundRoute Class`](./router/NotFoundRouteClass.md)
- [`createFileRoute`](./router/createFileRouteFunction.md)
- [`createLazyFileRoute`](./router/createLazyFileRouteFunction.md)
- [`createRootRoute`](./router/createRootRouteFunction.md)
- [`createRootRouteWithContext`](./router/createRootRouteWithContextFunction.md)
- [`createRoute`](./router/createRouteFunction.md)
- [`createLazyRoute`](./router/createLazyRouteFunction.md)
- [`createRouteMask`](./router/createRouteMaskFunction.md)
- [`createRouter`](./router/createRouterFunction.md)
- [`defer`](./router/deferFunction.md)
- [`getRouteApi`](./router/getRouteApiFunction.md)
- [`isNotFound`](./router/isNotFoundFunction.md)
- [`isRedirect`](./router/isRedirectFunction.md)
- [`lazyRouteComponent`](./router/lazyRouteComponentFunction.md)
- [`linkOptions`](./router/linkOptions.md)
- [`notFound`](./router/notFoundFunction.md)
- [`redirect`](./router/redirectFunction.md)
- [`retainSearchParams`](./router/retainSearchParamsFunction.md)
- [`stripSearchParams`](./router/stripSearchParamsFunction.md)
- Components
- [`<Await>`](./router/awaitComponent.md)
- [`<CatchBoundary>`](./router/catchBoundaryComponent.md)
- [`<CatchNotFound>`](./router/catchNotFoundComponent.md)
- [`<ClientOnly>`](./router/clientOnlyComponent.md)
- [`<DefaultGlobalNotFound>`](./router/defaultGlobalNotFoundComponent.md)
- [`<ErrorComponent>`](./router/errorComponentComponent.md)
- [`<Link>`](./router/linkComponent.md)
- [`<MatchRoute>`](./router/matchRouteComponent.md)
- [`<Navigate>`](./router/navigateComponent.md)
- [`<NotFoundComponent>`](./router/notFoundComponentComponent.md)
- [`<Outlet>`](./router/outletComponent.md)
- Hooks
- [`useAwaited`](./router/useAwaitedHook.md)
- [`useBlocker`](./router/useBlockerHook.md)
- [`useCanGoBack`](./router/useCanGoBack.md)
- [`useChildMatches`](./router/useChildMatchesHook.md)
- [`useLinkProps`](./router/useLinkPropsHook.md)
- [`useLoaderData`](./router/useLoaderDataHook.md)
- [`useLoaderDeps`](./router/useLoaderDepsHook.md)
- [`useLocation`](./router/useLocationHook.md)
- [`useMatch`](./router/useMatchHook.md)
- [`useMatchRoute`](./router/useMatchRouteHook.md)
- [`useMatches`](./router/useMatchesHook.md)
- [`useNavigate`](./router/useNavigateHook.md)
- [`useParentMatches`](./router/useParentMatchesHook.md)
- [`useParams`](./router/useParamsHook.md)
- [`useRouteContext`](./router/useRouteContextHook.md)
- [`useRouter`](./router/useRouterHook.md)
- [`useRouterState`](./router/useRouterStateHook.md)
- [`useSearch`](./router/useSearchHook.md)
- Types
- [`ActiveLinkOptions Type`](./router/ActiveLinkOptionsType.md)
- [`AsyncRouteComponent Type`](./router/AsyncRouteComponentType.md)
- [`HistoryState Interface`](./router/historyStateInterface.md)
- [`LinkOptions Type`](./router/LinkOptionsType.md)
- [`LinkProps Type`](./router/LinkPropsType.md)
- [`MatchRouteOptions Type`](./router/MatchRouteOptionsType.md)
- [`NavigateOptions Type`](./router/NavigateOptionsType.md)
- [`NotFoundError Type`](./router/NotFoundErrorType.md)
- [`ParsedHistoryState Type`](./router/ParsedHistoryStateType.md)
- [`ParsedLocation Type`](./router/ParsedLocationType.md)
- [`Redirect Type`](./router/RedirectType.md)
- [`Register Type`](./router/RegisterType.md)
- [`Route Type`](./router/RouteType.md)
- [`RouteApi Type`](./router/RouteApiType.md)
- [`RouteMask Type`](./router/RouteMaskType.md)
- [`RouteMatch Type`](./router/RouteMatchType.md)
- [`RouteOptions Type`](./router/RouteOptionsType.md)
- [`Router Type`](./router/RouterType.md)
- [`RouterEvents Type`](./router/RouterEventsType.md)
- [`RouterOptions Type`](./router/RouterOptionsType.md)
- [`RouterState Type`](./router/RouterStateType.md)
- [`ToMaskOptions Type`](./router/ToMaskOptionsType.md)
- [`ToOptions Type`](./router/ToOptionsType.md)
- [`UseMatchRouteOptions Type`](./router/UseMatchRouteOptionsType.md)
- [`ViewTransitionOptions Type`](./router/ViewTransitionOptionsType.md)
- ⚠️ Deprecated
- [`FileRoute Class`](./router/FileRouteClass.md)
- [`Route Class`](./router/RouteClass.md)
- [`Router Class`](./router/RouterClass.md)
- [`RouteApi Class`](./router/RouteApiClass.md)
- [`RootRoute Class`](./router/RootRouteClass.md)
- [`NotFoundRoute Class`](./router/NotFoundRouteClass.md)
🤖 Prompt for AI Agents
In docs/router/framework/react/api/router.md around lines 7 to 88, the link on
line 40 contains a double slash (`./router//useCanGoBack.md`); update that link
to the correct path `./router/useCanGoBack.md` so it matches the other entries
and resolves properly.

- [`rootRouteWithContext Function`](./router/rootRouteWithContextFunction.md)
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: ActiveLinkOptionsType
title: ActiveLinkOptions type
---

The `ActiveLinkOptions` type extends the [`LinkOptions`](../LinkOptionsType.md) type and contains additional options that can be used to describe how a link should be styled when it is active.
The `ActiveLinkOptions` type extends the [`LinkOptions`](./LinkOptionsType.md) type and contains additional options that can be used to describe how a link should be styled when it is active.

```tsx
type ActiveLinkOptions = LinkOptions & {
Expand Down
6 changes: 3 additions & 3 deletions docs/router/framework/react/api/router/FileRouteClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: FileRoute class

> [!CAUTION]
> This class has been deprecated and will be removed in the next major version of TanStack Router.
> Please use the [`createFileRoute`](../createFileRouteFunction.md) function instead.
> Please use the [`createFileRoute`](./createFileRouteFunction.md) function instead.

The `FileRoute` class is a factory that can be used to create a file-based route instance. This route instance can then be used to automatically generate a route tree with the `tsr generate` and `tsr watch` commands.

Expand Down Expand Up @@ -34,13 +34,13 @@ The `createRoute` method is a method that can be used to configure the file rout
#### .createRoute options

- Type: `Omit<RouteOptions, 'getParentRoute' | 'path' | 'id'>`
- [`RouteOptions`](../RouteOptionsType.md)
- [`RouteOptions`](./RouteOptionsType.md)
- Optional
- The same options that are available to the `Route` class, but with the `getParentRoute`, `path`, and `id` options omitted since they are unnecessary for file-based routing.

#### .createRoute returns

A [`Route`](../RouteType.md) instance that can be used to configure the route to be inserted into the route-tree.
A [`Route`](./RouteType.md) instance that can be used to configure the route to be inserted into the route-tree.

> ⚠️ Note: For `tsr generate` and `tsr watch` to work properly, the file route instance must be exported from the file using the `Route` identifier.

Expand Down
4 changes: 2 additions & 2 deletions docs/router/framework/react/api/router/LinkOptionsType.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: LinkOptionsType
title: LinkOptions type
---

The `LinkOptions` type extends the [`NavigateOptions`](../NavigateOptionsType.md) type and contains additional options that can be used by TanStack Router when handling actual anchor element attributes.
The `LinkOptions` type extends the [`NavigateOptions`](./NavigateOptionsType.md) type and contains additional options that can be used by TanStack Router when handling actual anchor element attributes.

```tsx
type LinkOptions = NavigateOptions & {
Expand Down Expand Up @@ -36,7 +36,7 @@ The `LinkOptions` object accepts/contains the following properties:
- Type: `false | 'intent' | 'viewport' | 'render'`
- Optional
- If set, the link's preloading strategy will be set to this value.
- See the [Preloading guide](../../../guide/preloading.md) for more information.
- See the [Preloading guide](../../guide/preloading.md) for more information.

### `preloadDelay`

Expand Down
4 changes: 2 additions & 2 deletions docs/router/framework/react/api/router/LinkPropsType.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: LinkPropsType
title: LinkProps type
---

The `LinkProps` type extends the [`ActiveLinkOptions`](../ActiveLinkOptionsType.md) and `React.AnchorHTMLAttributes<HTMLAnchorElement>` types and contains additional props specific to the `Link` component.
The `LinkProps` type extends the [`ActiveLinkOptions`](./ActiveLinkOptionsType.md) and `React.AnchorHTMLAttributes<HTMLAnchorElement>` types and contains additional props specific to the `Link` component.

```tsx
type LinkProps = ActiveLinkOptions &
Expand All @@ -16,7 +16,7 @@ type LinkProps = ActiveLinkOptions &

## LinkProps properties

- All of the props from [`ActiveLinkOptions`](../ActiveLinkOptionsType.md)
- All of the props from [`ActiveLinkOptions`](./ActiveLinkOptionsType.md)
- All of the props from `React.AnchorHTMLAttributes<HTMLAnchorElement>`

#### `children`
Expand Down
4 changes: 2 additions & 2 deletions docs/router/framework/react/api/router/NavigateOptionsType.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The `NavigateOptions` object accepts the following properties:
- Optional
- Defaults to `false`.
- If `true`, navigation will be called using `document.startViewTransition()`.
- If [`ViewTransitionOptions`](../ViewTransitionOptionsType.md), route navigations will be called using `document.startViewTransition({update, types})` where `types` will determine the strings array passed with `ViewTransitionOptions["types"]`. If the browser does not support viewTransition types, the navigation will fall back to normal `document.startTransition()`, same as if `true` was passed.
- If [`ViewTransitionOptions`](./ViewTransitionOptionsType.md), route navigations will be called using `document.startViewTransition({update, types})` where `types` will determine the strings array passed with `ViewTransitionOptions["types"]`. If the browser does not support viewTransition types, the navigation will fall back to normal `document.startTransition()`, same as if `true` was passed.
- If the browser does not support this api, this option will be ignored.
- See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for more information on how this function works.
- See [Google](https://developer.chrome.com/docs/web-platform/view-transitions/same-document#view-transition-types) for more information on viewTransition types
Expand All @@ -75,4 +75,4 @@ The `NavigateOptions` object accepts the following properties:
- Optional
- This can be used instead of `to` to navigate to a fully built href, e.g. pointing to an external target.

- [`ToOptions`](../ToOptionsType.md)
- [`ToOptions`](./ToOptionsType.md)
4 changes: 2 additions & 2 deletions docs/router/framework/react/api/router/NotFoundRouteClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: NotFoundRoute class
> [!CAUTION]
> This class has been deprecated and will be removed in the next major version of TanStack Router.
> Please use the `notFoundComponent` route option that is present during route configuration.
> See the [Not Found Errors guide](../../../guide/not-found-errors.md) for more information.
> See the [Not Found Errors guide](../../guide/not-found-errors.md) for more information.

The `NotFoundRoute` class extends the `Route` class and can be used to create a not found route instance. A not found route instance can be passed to the `routerOptions.notFoundRoute` option to configure a default not-found/404 route for every branch of the route tree.

Expand All @@ -28,7 +28,7 @@ Omit<
>
```

- [RouteOptions](../RouteOptionsType.md)
- [RouteOptions](./RouteOptionsType.md)
- Required
- The options that will be used to configure the not found route instance.

Expand Down
2 changes: 1 addition & 1 deletion docs/router/framework/react/api/router/RedirectType.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type Redirect = {
} & NavigateOptions
```

- [`NavigateOptions`](../NavigateOptionsType.md)
- [`NavigateOptions`](./NavigateOptionsType.md)

## Redirect properties

Expand Down
6 changes: 3 additions & 3 deletions docs/router/framework/react/api/router/RootRouteClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: RootRoute class

> [!CAUTION]
> This class has been deprecated and will be removed in the next major version of TanStack Router.
> Please use the [`createRootRoute`](../createRootRouteFunction.md) function instead.
> Please use the [`createRootRoute`](./createRootRouteFunction.md) function instead.

The `RootRoute` class extends the `Route` class and can be used to create a root route instance. A root route instance can then be used to create a route tree.

Expand All @@ -31,12 +31,12 @@ Omit<
>
```

- [`RouteOptions`](../RouteOptionsType.md)
- [`RouteOptions`](./RouteOptionsType.md)
- Optional

## Constructor returns

A new [`Route`](../RouteType.md) instance.
A new [`Route`](./RouteType.md) instance.

## Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/router/framework/react/api/router/RouteApiClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: RouteApi class

> [!CAUTION]
> This class has been deprecated and will be removed in the next major version of TanStack Router.
> Please use the [`getRouteApi`](../getRouteApiFunction.md) function instead.
> Please use the [`getRouteApi`](./getRouteApiFunction.md) function instead.

The `RouteApi` class provides type-safe version of common hooks like `useParams`, `useSearch`, `useRouteContext`, `useNavigate`, `useLoaderData`, and `useLoaderDeps` that are pre-bound to a specific route ID and corresponding registered route types.

Expand All @@ -21,7 +21,7 @@ The `RouteApi` constructor accepts a single argument: the `options` that will be

## Constructor returns

- An instance of the [`RouteApi`](../RouteApiType.md) that is pre-bound to the route ID that it was called with.
- An instance of the [`RouteApi`](./RouteApiType.md) that is pre-bound to the route ID that it was called with.

## Examples

Expand Down
Loading
Loading