Skip to content

feat(start): type level serialization #4231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 128 commits into
base: alpha
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
855b03f
Devinxi (#4111)
tannerlinsley May 10, 2025
6e5b7a3
fix: RELEASE_ALL
schiller-manuel May 10, 2025
1ceda30
release: v1.20.3-alpha.1
tannerlinsley May 10, 2025
0b7aefd
fix: RELEASE_ALL
schiller-manuel May 10, 2025
bc2dfa1
release: v1.120.4-alpha.1
tannerlinsley May 10, 2025
e3fd36b
fix: clean up Vite versions (#4130)
XiNiHa May 10, 2025
82d14bd
docs(start): Fix contents outdated by Devinxi (#4125)
XiNiHa May 10, 2025
c997f90
release: v1.120.4-alpha.2
tannerlinsley May 10, 2025
736a572
fix: declare `vite` as a `peerDependency` (#4135)
SeanCassiere May 10, 2025
99a944b
release: v1.120.4-alpha.3
tannerlinsley May 10, 2025
35f6520
fix(router-generator): exit conditions when using `verboseFileRoutes`…
SeanCassiere May 11, 2025
ef337e7
release: v1.120.4-alpha.4
tannerlinsley May 11, 2025
94400a2
fix(start-plugin-core): patches for Virtual Routes in Server Routes (…
SeanCassiere May 11, 2025
016e5f0
release: v1.120.4-alpha.5
tannerlinsley May 11, 2025
20937af
fix(start-plugin-core): include "vite/client" types (#4139)
SeanCassiere May 11, 2025
a57676e
release: v1.120.4-alpha.6
tannerlinsley May 11, 2025
d5c2e6d
fix(start-server-core): appending headers to immutable response objec…
MoeedDar May 11, 2025
bef4dab
ci: apply automated fixes
autofix-ci[bot] May 11, 2025
565c8a0
chore: lint
schiller-manuel May 11, 2025
6542287
release: v1.120.4-alpha.7
tannerlinsley May 11, 2025
94c1284
refactor(start-server-core): use utility functions from router-core (…
SeanCassiere May 11, 2025
4533d30
release: v1.120.4-alpha.8
tannerlinsley May 11, 2025
62a044e
docs(start): remove validators from "server routes" guide (#4148)
ssijak May 11, 2025
ac7db71
fix(start-plugin-core): remove backslashes from declaration import (#…
SeanCassiere May 11, 2025
32f1a8b
release: v1.120.4-alpha.9
tannerlinsley May 11, 2025
9f63d40
feat(router-core): type level parsing of path params (#4144)
chorobin May 11, 2025
8d4a7e8
release: v1.120.4-alpha.10
tannerlinsley May 11, 2025
6bde41f
docs(start): Server Functions can be called from Server Routes (#4154)
ryanagillie May 12, 2025
e6fab6a
docs(start): server-routes (#4155)
schiller-manuel May 12, 2025
418fac9
docs: update build from scratch
schiller-manuel May 12, 2025
3f33f04
fix: remove set/get global origin (#4157)
schiller-manuel May 12, 2025
6f764c2
release: v1.120.4-alpha.11
tannerlinsley May 12, 2025
9882e30
fix: properly handle redirects thrown by server functions (#4156)
schiller-manuel May 12, 2025
6d428d3
release: v1.120.4-alpha.12
tannerlinsley May 12, 2025
c81090d
docs(start): document that serverFn can be used in server routes (#4152)
kandros May 12, 2025
abb047e
fix: remove unused header (#4160)
schiller-manuel May 12, 2025
4e0638b
feat(react-start): Wrap default client entry with `<StrictMode>` (#4159)
ryanagillie May 12, 2025
55e54e1
release: v1.120.4-alpha.13
tannerlinsley May 12, 2025
a153fda
docs(start): update src path for images
birkskyum May 13, 2025
2559877
fix: remove undici (#4168)
schiller-manuel May 13, 2025
0a66147
release: v1.120.4-alpha.14
tannerlinsley May 13, 2025
273c4c1
feat: shell mode
tannerlinsley May 13, 2025
1e894bc
solidjs shell mode
birkskyum May 13, 2025
4225562
ci: apply automated fixes
autofix-ci[bot] May 13, 2025
10eed5f
fix: Do not default to shell mode
tannerlinsley May 13, 2025
f727dac
fix: nitro-plugin types
tannerlinsley May 13, 2025
3cbd11a
release: v1.120.4-alpha.15
tannerlinsley May 13, 2025
1417d17
fix: ensure compatibility with vite plugins that don't support the vi…
schiller-manuel May 13, 2025
063ccf6
release: v1.120.4-alpha.16
tannerlinsley May 13, 2025
9fd4290
docs(solid-start): correctly set link to spa-shell
birkskyum May 14, 2025
475556e
docs(solid-start): fix server routes docs
birkskyum May 14, 2025
14bcc58
fix: recover from server pathname mismatch
tannerlinsley May 14, 2025
595b0d0
release: v1.120.4-alpha.17
tannerlinsley May 14, 2025
0cca049
chore: dedupe and fix lockfile (#4171)
SeanCassiere May 15, 2025
16705fa
fix: resolve custom `client` and `server` entry paths (#4172)
SeanCassiere May 15, 2025
fbfd801
release: v1.120.4-alpha.18
tannerlinsley May 15, 2025
f940f85
docs(server.ts/ssr.ts): cleanup redundant files and update docs
birkskyum May 15, 2025
5f8506b
ci: apply automated fixes
autofix-ci[bot] May 15, 2025
7f5ba87
fix: relative runtime navigation (#4174)
tannerlinsley May 15, 2025
52cdc7e
release: v1.120.4-alpha.19
tannerlinsley May 15, 2025
b901793
fix: spa-mode (#4177)
tannerlinsley May 15, 2025
4aa766b
release: v1.120.4-alpha.20
tannerlinsley May 15, 2025
b424cad
fix: no `@fs` in dev for client entry (#4179)
tannerlinsley May 15, 2025
b5affb2
release: v1.120.4-alpha.21
tannerlinsley May 15, 2025
f209861
fix: resolve custom `server` entry path on windows fs (#4180)
yjoer May 15, 2025
7cf6487
release: v1.120.4-alpha.22
tannerlinsley May 15, 2025
b339e67
fix: resolve custom `client` entry path on windows fs (#4181)
SeanCassiere May 15, 2025
cb21bb5
release: v1.120.4-alpha.23
tannerlinsley May 15, 2025
f430560
feat(start-server-core): resolve relative requests to the same origin…
SeanCassiere May 16, 2025
7a6cbee
release: v1.120.4-alpha.24
tannerlinsley May 16, 2025
9e0d2d6
fix(start-plugin-core): enable pre-rendering with just `pages` (#4185)
SeanCassiere May 16, 2025
fda4179
release: v1.120.4-alpha.25
tannerlinsley May 16, 2025
15b8ed6
chore: various fixes (#4187)
schiller-manuel May 16, 2025
f2d1d54
merge main (#4191)
schiller-manuel May 16, 2025
e03ad0c
fix: RELEASE_ALL
SeanCassiere May 16, 2025
ed33706
release: v1.121.0-alpha.1
tannerlinsley May 16, 2025
6187e24
fix: add support for 'using' (#4194)
schiller-manuel May 17, 2025
8fee26d
release: v1.121.0-alpha.2
tannerlinsley May 17, 2025
3f8dacd
chore: simplify test for 'using' (#4196)
schiller-manuel May 17, 2025
0f12171
chore: router plugin restructuring (#4199)
schiller-manuel May 18, 2025
487d1bc
fix: allow head to be async (#4213)
schiller-manuel May 20, 2025
e5e8e02
release: v1.121.0-alpha.3
tannerlinsley May 20, 2025
3a5a764
refactor(start-plugin-core): omit `autoCodeSplitting` configuration o…
SeanCassiere May 21, 2025
6461704
release: v1.121.0-alpha.4
tannerlinsley May 21, 2025
cf9e5bc
fix: buildLocation (#4210)
tannerlinsley May 21, 2025
2b17f15
release: v1.121.0-alpha.5
tannerlinsley May 21, 2025
a5d2740
fix: sitemap support (#4217)
tannerlinsley May 21, 2025
7670d79
release: v1.121.0-alpha.6
tannerlinsley May 21, 2025
b8db2d9
fix: one more test
tannerlinsley May 21, 2025
a769bc9
fix: all tests
tannerlinsley May 21, 2025
389207e
feat: add poc of seroval serialiser adapter on the type level
chorobin May 22, 2025
1e83f3e
Merge remote-tracking branch 'origin/alpha' into types-seroval-serial…
chorobin May 22, 2025
05a19c3
chore: fix solid types
chorobin May 22, 2025
8a76fa7
refactor: consistent virtual module naming and resolve using Rollup c…
SeanCassiere May 22, 2025
f06a29b
release: v1.121.0-alpha.7
tannerlinsley May 22, 2025
baf6a52
feat(server-functions-plugin): make the manifest output path configur…
SeanCassiere May 22, 2025
dd34efe
release: v1.121.0-alpha.8
tannerlinsley May 22, 2025
42e075c
fix(start-plugin-core): prepend `/@fs` when a custom client entry is …
yjoer May 22, 2025
fad6b0b
release: v1.121.0-alpha.9
tannerlinsley May 22, 2025
496fac3
fix: make sitemap accessible via public assets (#4235)
SeanCassiere May 23, 2025
bcbd08a
release: v1.121.0-alpha.10
tannerlinsley May 23, 2025
5a3f7ad
fix: better unsafeRelative, support router.navigate() (#4236)
tannerlinsley May 23, 2025
4bdeda8
release: v1.121.0-alpha.11
tannerlinsley May 23, 2025
8895961
refactor: move resolution of virtual entry handlers to core (#4238)
SeanCassiere May 23, 2025
100560f
release: v1.121.0-alpha.12
tannerlinsley May 23, 2025
aea93b4
Squashed commit of the following:
tannerlinsley May 24, 2025
aa94daa
fix: normalize router filepath (#4247)
yjoer May 24, 2025
618b91f
release: v1.121.0-alpha.13
tannerlinsley May 24, 2025
35d9c60
merge main into alpha (#4251)
schiller-manuel May 24, 2025
91ef1b0
fix: dynamically import virtual modules (#4252)
schiller-manuel May 24, 2025
b3dae31
release: v1.121.0-alpha.14
tannerlinsley May 24, 2025
e165d60
refactor: rename internal functions and limit deploy bundler defaults…
SeanCassiere May 25, 2025
7e7b436
release: v1.121.0-alpha.15
tannerlinsley May 25, 2025
5aa3424
fix(start-plugin-core): recursively import CSS assets (#4254)
ilarramendi May 26, 2025
e95834e
release: v1.121.0-alpha.16
tannerlinsley May 26, 2025
481582e
refactor: use createStart
chorobin May 26, 2025
dea9a58
chore: remove serializer from router
chorobin May 26, 2025
5ce936f
fix: support usage of a prefixed a base path (#4258)
SeanCassiere May 27, 2025
b74d5f2
release: v1.121.0-alpha.17
tannerlinsley May 27, 2025
6832dbb
refactor(start-plugin-core): rename output to `route-assets-manifest`
SeanCassiere May 28, 2025
e578e5f
release: v1.121.0-alpha.18
tannerlinsley May 28, 2025
f8ca2a6
chore(start-plugin-core): add comments for internal (#4261)
SeanCassiere May 28, 2025
a02afb6
feat(start-plugin-core): load all environment variables for dev (#4262)
SeanCassiere May 28, 2025
6d50013
release: v1.121.0-alpha.19
tannerlinsley May 28, 2025
423f6c0
chore(start-plugin-core): reorganize and centralize the plugin orches…
SeanCassiere May 28, 2025
457078a
Merge remote-tracking branch 'origin/alpha' into types-seroval-serial…
chorobin May 29, 2025
81e6787
feat: add serialisation of loaders, beforeLoad and context
chorobin May 29, 2025
ada0a09
feat: add serialization settings
chorobin Jun 1, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
32 changes: 10 additions & 22 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,12 @@
- 'packages/react-router-with-query/**/*'
'package: react-start':
- 'packages/react-start/**/*'
'package: start-api-routes':
- 'packages/start-api-routes/**/*'
'package: react-start-client':
- 'packages/react-start-client/**/*'
'package: react-start-config':
- 'packages/react-start-config/**/*'
'package: react-start-plugin':
- 'packages/react-start-plugin/**/*'
'package: react-start-router-manifest':
- 'packages/react-start-router-manifest/**/*'
'package: react-start-server':
- 'packages/react-start-server/**/*'
'package: start-server-functions-client':
- 'packages/start-server-functions-client/**/*'
'package: start-server-functions-fetcher':
- 'packages/start-server-functions-fetcher/**/*'
'package: start-server-functions-handler':
- 'packages/start-server-functions-handler/**/*'
'package: start-server-functions-ssr':
- 'packages/start-server-functions-ssr/**/*'
'package: router-cli':
- 'packages/router-cli/**/*'
'package: router-core':
Expand All @@ -60,18 +46,20 @@
- 'packages/solid-start/**/*'
'package: solid-start-client':
- 'packages/solid-start-client/**/*'
'package: solid-start-config':
- 'packages/solid-start-config/**/*'
'package: solid-start-plugin':
- 'packages/solid-start-plugin/**/*'
'package: solid-start-router-manifest':
- 'packages/solid-start-router-manifest/**/*'
'package: solid-start-server':
- 'packages/solid-start-server/**/*'
'package: start':
- 'packages/start/**/*'
'package: start-config':
- 'packages/start-config/**/*'
'package: start-client-core':
- 'packages/start-client-core/**/*'
'package: start-plugin-core':
- 'packages/start-plugin-core/**/*'
'package: start-server-core':
- 'packages/start-server-core/**/*'
'package: start-server-functions-client':
- 'packages/start-server-functions-client/**/*'
'package: start-server-functions-fetcher':
- 'packages/start-server-functions-fetcher/**/*'
'package: start-server-functions-server':
- 'packages/start-server-functions-server/**/*'
'package: valibot-adapter':
Expand Down
12 changes: 5 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,18 @@ nx-cloud.env

gpt/db.json

app.config.timestamp-*
vite.config.timestamp-*
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
app.config.js.timestamp-*
app.config.ts.timestamp-*

app.config.timestamp_*
vite.config.timestamp_*
vite.config.js.timestamp_*
vite.config.ts.timestamp_*
app.config.js.timestamp_*
app.config.ts.timestamp_*

.idea
*.vitest-temp.json

# Handling VSCode settings
/.vscode/
!/examples/react/**/.vscode/settings.json
!/examples/react/**/.vscode/settings.json
**/.tanstack-start/build
1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
pnpm-lock.yaml
**/snapshots
**/.vercel
**/.vinxi
**/.output
**/node_modules
node_modules
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ Enjoy this library? Try the entire [TanStack](https://tanstack.com)! [React Quer

To run example React projects with Tanstack Router, see [CONTRIBUTING.md](./CONTRIBUTING.md)

<!-- Use the force, Luke!!!! -->
<!-- Use the force, Luke!!! -->
13 changes: 0 additions & 13 deletions docs/router/api/file-based-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,6 @@ By default, this value is set to `false`.
> [!TIP]
> You should ignore the path of your generated route tree file from your linter and formatter to avoid conflicts.
### `apiBase`

As a framework, [TanStack Start](/start) supports the concept of API routes. This option configures the base path for API routes.

By default, this value is set to `/api`.

This means that all API routes will be prefixed with `/api`.

This configuration value is only useful if you are using TanStack Start.

> [!IMPORTANT]
> This default value may conflict with your own project's routing if you planned on having a normal route with the same base path. You can change this value to avoid conflicts.
### `autoCodeSplitting`

This feature is only available is you are using the TanStack Router Bundler Plugin.
Expand Down
4 changes: 2 additions & 2 deletions docs/router/eslint/create-route-property-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Examples of **incorrect** code for this rule:
/* eslint "@tanstack/router/create-route-property-order": "warn" */
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/foo/bar/$id')({
export const Route = createFileRoute({
loader: async ({context}) => {
await context.queryClient.ensureQueryData(getQueryOptions(context.hello)),
},
Expand All @@ -43,7 +43,7 @@ Examples of **correct** code for this rule:
/* eslint "@tanstack/router/create-route-property-order": "warn" */
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/foo/bar/$id')({
export const Route = createFileRoute({
beforeLoad: () => ({hello: 'world'}),
loader: async ({context}) => {
await context.queryClient.ensureQueryData(getQueryOptions(context.hello)),
Expand Down
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,4 +102,4 @@ 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)
156 changes: 78 additions & 78 deletions docs/router/framework/react/api/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,85 +4,85 @@ 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)
- [`<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)
- [`<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)
- [`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 be 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 be 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)
Loading