You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/ActiveLinkOptionsType.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ id: ActiveLinkOptionsType
3
3
title: ActiveLinkOptions type
4
4
---
5
5
6
-
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.
6
+
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.
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/FileRouteClass.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: FileRoute class
5
5
6
6
> [!CAUTION]
7
7
> This class has been deprecated and will be removed in the next major version of TanStack Router.
8
-
> Please use the [`createFileRoute`](../createFileRouteFunction.md) function instead.
8
+
> Please use the [`createFileRoute`](./createFileRouteFunction.md) function instead.
9
9
10
10
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.
11
11
@@ -34,13 +34,13 @@ The `createRoute` method is a method that can be used to configure the file rout
- 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.
40
40
41
41
#### .createRoute returns
42
42
43
-
A [`Route`](../RouteType.md) instance that can be used to configure the route to be inserted into the route-tree.
43
+
A [`Route`](./RouteType.md) instance that can be used to configure the route to be inserted into the route-tree.
44
44
45
45
> ⚠️ Note: For `tsr generate` and `tsr watch` to work properly, the file route instance must be exported from the file using the `Route` identifier.
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/LinkOptionsType.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ id: LinkOptionsType
3
3
title: LinkOptions type
4
4
---
5
5
6
-
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.
6
+
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.
7
7
8
8
```tsx
9
9
typeLinkOptions=NavigateOptions& {
@@ -36,7 +36,7 @@ The `LinkOptions` object accepts/contains the following properties:
36
36
- Type: `false|'intent'|'viewport'|'render'`
37
37
- Optional
38
38
- If set, the link's preloading strategy will be set to this value.
39
-
- See the [Preloading guide](../../../guide/preloading.md) for more information.
39
+
- See the [Preloading guide](../../guide/preloading.md) for more information.
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/LinkPropsType.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ id: LinkPropsType
3
3
title: LinkProps type
4
4
---
5
5
6
-
The `LinkProps` type extends the [`ActiveLinkOptions`](../ActiveLinkOptionsType.md) and `React.AnchorHTMLAttributes<HTMLAnchorElement>` types and contains additional props specific to the `Link` component.
6
+
The `LinkProps` type extends the [`ActiveLinkOptions`](./ActiveLinkOptionsType.md) and `React.AnchorHTMLAttributes<HTMLAnchorElement>` types and contains additional props specific to the `Link` component.
7
7
8
8
```tsx
9
9
typeLinkProps=ActiveLinkOptions&
@@ -16,7 +16,7 @@ type LinkProps = ActiveLinkOptions &
16
16
17
17
## LinkProps properties
18
18
19
-
- All of the props from [`ActiveLinkOptions`](../ActiveLinkOptionsType.md)
19
+
- All of the props from [`ActiveLinkOptions`](./ActiveLinkOptionsType.md)
20
20
- All of the props from `React.AnchorHTMLAttributes<HTMLAnchorElement>`
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/NavigateOptionsType.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ The `NavigateOptions` object accepts the following properties:
50
50
- Optional
51
51
- Defaults to `false`.
52
52
- If `true`, navigation will be called using `document.startViewTransition()`.
53
-
- 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.
53
+
- 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.
54
54
- If the browser does not support this api, this option will be ignored.
55
55
- See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for more information on how this function works.
56
56
- See [Google](https://developer.chrome.com/docs/web-platform/view-transitions/same-document#view-transition-types) for more information on viewTransition types
@@ -75,4 +75,4 @@ The `NavigateOptions` object accepts the following properties:
75
75
- Optional
76
76
- This can be used instead of `to` to navigate to a fully built href, e.g. pointing to an external target.
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/NotFoundRouteClass.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: NotFoundRoute class
6
6
> [!CAUTION]
7
7
> This class has been deprecated and will be removed in the next major version of TanStack Router.
8
8
> Please use the `notFoundComponent` route option that is present during route configuration.
9
-
> See the [Not Found Errors guide](../../../guide/not-found-errors.md) for more information.
9
+
> See the [Not Found Errors guide](../../guide/not-found-errors.md) for more information.
10
10
11
11
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.
12
12
@@ -28,7 +28,7 @@ Omit<
28
28
>
29
29
```
30
30
31
-
-[RouteOptions](../RouteOptionsType.md)
31
+
-[RouteOptions](./RouteOptionsType.md)
32
32
- Required
33
33
- The options that will be used to configure the not found route instance.
Copy file name to clipboardExpand all lines: docs/router/framework/react/api/router/RootRouteClass.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: RootRoute class
5
5
6
6
> [!CAUTION]
7
7
> This class has been deprecated and will be removed in the next major version of TanStack Router.
8
-
> Please use the [`createRootRoute`](../createRootRouteFunction.md) function instead.
8
+
> Please use the [`createRootRoute`](./createRootRouteFunction.md) function instead.
9
9
10
10
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.
0 commit comments