export default `# Authenticated Routes
Authentication is an extremely common requirement for web applications. In this guide, we'll walk through how to use TanStack Router to build protected routes, and how to redirect users to login if they try to access them.
## The \`route.beforeLoad\` Option
The \`route.beforeLoad\` option allows you to specify a function that will be called before a route is loaded. It receives all of the same arguments that the \`route.loader\` function does. This is a great place to check if a user is authenticated, and redirect them to a login page if they are not.
The \`beforeLoad\` function runs in relative order to these other route loading functions:
- Route Matching (Top-Down)
- \`route.params.parse\`
- \`route.validateSearch\`
- Route Loading (including Preloading)
- **\`route.beforeLoad\`**
- \`route.onError\`
- Route Loading (Parallel)
- \`route.component.preload?\`
- \`route.load\`
**It's important to know that the \`beforeLoad\` function for a route is called _before any of its child routes' \`beforeLoad\` functions_.** It is essentially a middleware function for the route and all of its children.
**If you throw an error in \`beforeLoad\`, none of its children will attempt to load**.
## Redirecting
While not required, some authentication flows require redirecting to a login page. To do this, you can **throw a \`redirect()\`** from \`beforeLoad\`:
\`\`\`tsx
// src/routes/_authenticated.tsx
export const Route = createFileRoute('/_authenticated')({
beforeLoad: async ({ location }) => {
if (!isAuthenticated()) {
throw redirect({
to: '/login',
search: {
// Use the current location to power a redirect after login
// (Do not use \`router.state.resolvedLocation\` as it can
// potentially lag behind the actual current location)
redirect: location.href,
},
})
}
},
})
\`\`\`
> [!TIP]
> The \`redirect()\` function takes all of the same options as the \`navigate\` function, so you can pass options like \`replace: true\` if you want to replace the current history entry instead of adding a new one.
### Handling Auth Check Failures
If your authentication check can throw errors (network failures, token validation, etc.), wrap it in try/catch:
# React
\`\`\`tsx
import { createFileRoute, redirect, isRedirect } from '@tanstack/react-router'
// src/routes/_authenticated.tsx
export const Route = createFileRoute('/_authenticated')({
beforeLoad: async ({ location }) => {
try {
const user = await verifySession() // might throw on network error
if (!user) {
throw redirect({
to: '/login',
search: { redirect: location.href },
})
}
return { user }
} catch (error) {
// Re-throw redirects (they're intentional, not errors)
if (isRedirect(error)) throw error
// Auth check failed (network error, etc.) - redirect to login
throw redirect({
to: '/login',
search: { redirect: location.href },
})
}
},
})
\`\`\`
# Solid
\`\`\`tsx
import { createFileRoute, redirect, isRedirect } from '@tanstack/solid-router'
// src/routes/_authenticated.tsx
export const Route = createFileRoute('/_authenticated')({
beforeLoad: async ({ location }) => {
try {
const user = await verifySession() // might throw on network error
if (!user) {
throw redirect({
to: '/login',
search: { redirect: location.href },
})
}
return { user }
} catch (error) {
// Re-throw redirects (they're intentional, not errors)
if (isRedirect(error)) throw error
// Auth check failed (network error, etc.) - redirect to login
throw redirect({
to: '/login',
search: { redirect: location.href },
})
}
},
})
\`\`\`
The [\`isRedirect()\`](../api/router/isRedirectFunction.md) helper distinguishes between actual errors and intentional redirects.
Once you have authenticated a user, it's also common practice to redirect them back to the page they were trying to access. To do this, you can utilize the \`redirect\` search param that we added in our original redirect. Since we'll be replacing the entire URL with what it was, \`router.history.push\` is better suited for this than \`router.navigate\`:
\`\`\`tsx
router.history.push(search.redirect)
\`\`\`
## Non-Redirected Authentication
Some applications choose to not redirect users to a login page, and instead keep the user on the same page and show a login form that either replaces the main content or hides it via a modal. This is also possible with TanStack Router by simply short circuiting rendering the \`\` that would normally render the child routes:
\`\`\`tsx
// src/routes/_authenticated.tsx
export const Route = createFileRoute('/_authenticated')({
component: () => {
if (!isAuthenticated()) {
return
}
return
},
})
\`\`\`
This keeps the user on the same page, but still allows you to render a login form. Once the user is authenticated, you can simply render the \`\` and the child routes will be rendered.
## Authentication using React context/hooks
If your authentication flow relies on interactions with React context and/or hooks, you'll need to pass down your authentication state to TanStack Router using \`router.context\` option.
> [!IMPORTANT]
> React hooks are not meant to be consumed outside of React components. If you need to use a hook outside of a React component, you need to extract the returned state from the hook in a component that wraps your \`\` and then pass the returned value down to TanStack Router.
We'll cover the \`router.context\` options in-detail in the [Router Context](./router-context.md) section.
Here's an example that uses React context and hooks for protecting authenticated routes in TanStack Router. See the entire working setup in the [Authenticated Routes example](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes).
# React
\`\`\`tsx title="src/routes/__root.tsx"
import { createRootRouteWithContext } from '@tanstack/react-router'
interface MyRouterContext {
// The ReturnType of your useAuth hook or the value of your AuthContext
auth: AuthState
}
export const Route = createRootRouteWithContext()({
component: () => ,
})
\`\`\`
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'
export const router = createRouter({
routeTree,
context: {
// auth will initially be undefined
// We'll be passing down the auth state from within a React component
auth: undefined!,
},
})
\`\`\`
\`\`\`tsx title="src/App.tsx"
import { RouterProvider } from '@tanstack/react-router'
import { AuthProvider, useAuth } from './auth'
import { router } from './router'
function InnerApp() {
const auth = useAuth()
return
}
function App() {
return (
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/__root.tsx"
import { createRootRouteWithContext } from '@tanstack/solid-router'
interface MyRouterContext {
// The ReturnType of your useAuth hook or the value of your AuthContext
auth: AuthState
}
export const Route = createRootRouteWithContext()({
component: () => ,
})
\`\`\`
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/solid-router'
import { routeTree } from './routeTree.gen'
export const router = createRouter({
routeTree,
context: {
// auth will initially be undefined
// We'll be passing down the auth state from within a React component
auth: undefined!,
},
})
\`\`\`
\`\`\`tsx title="src/App.tsx"
import { RouterProvider } from '@tanstack/solid-router'
import { AuthProvider, useAuth } from './auth'
import { router } from './router'
function InnerApp() {
const auth = useAuth()
return
}
function App() {
return (
)
}
\`\`\`
Then in the authenticated route, you can check the auth state using the \`beforeLoad\` function, and **throw a \`redirect()\`** to your **Login route** if the user is not signed-in.
# React
\`\`\`tsx title="src/routes/dashboard.route.tsx"
import { createFileRoute, redirect } from '@tanstack/react-router'
export const Route = createFileRoute('/dashboard')({
beforeLoad: ({ context, location }) => {
if (!context.auth.isAuthenticated) {
throw redirect({
to: '/login',
search: {
redirect: location.href,
},
})
}
},
})
\`\`\`
# Solid
\`\`\`tsx title="src/routes/dashboard.route.tsx"
import { createFileRoute, redirect } from '@tanstack/solid-router'
export const Route = createFileRoute('/dashboard')({
beforeLoad: ({ context, location }) => {
if (!context.auth.isAuthenticated()) {
throw redirect({
to: '/login',
search: {
redirect: location.href,
},
})
}
},
})
\`\`\`
You can _optionally_, also use the [Non-Redirected Authentication](#non-redirected-authentication) approach to show a login form instead of calling a **redirect**.
This approach can also be used in conjunction with Pathless or Layout Route to protect all routes under their parent route.
## Related How-To Guides
For detailed, step-by-step implementation guides, see:
- [How to Set Up Basic Authentication](../how-to/setup-authentication.md) - Complete setup with React Context and protected routes
- [How to Integrate Authentication Providers](../how-to/setup-auth-providers.md) - Use Auth0, Clerk, or Supabase
- [How to Set Up Role-Based Access Control](../how-to/setup-rbac.md) - Implement permissions and role-based routing
## Examples
Working authentication examples are available in the repository:
- [Basic Authentication Example](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes) - Simple authentication with context
- [Firebase Authentication](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes-firebase) - Firebase Auth integration
- [TanStack Start Auth Examples](https://github.com/TanStack/router/tree/main/examples/react) - Various auth implementations with TanStack Start
# Automatic Code Splitting
The automatic code splitting feature in TanStack Router allows you to optimize your application's bundle size by lazily loading route components and their associated data. This is particularly useful for large applications where you want to minimize the initial load time by only loading the necessary code for the current route.
To turn this feature on, simply set the \`autoCodeSplitting\` option to \`true\` in your bundler plugin configuration. This enables the router to automatically handle code splitting for your routes without requiring any additional setup.
\`\`\`ts
// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackRouter } from '@tanstack/router-plugin/vite'
export default defineConfig({
plugins: [
tanstackRouter({
autoCodeSplitting: true, // Enable automatic code splitting
}),
],
})
\`\`\`
But that's just the beginning! TanStack Router's automatic code splitting is not only easy to enable, but it also provides powerful customization options to tailor how your routes are split into chunks. This allows you to optimize your application's performance based on your specific needs and usage patterns.
## How does it work?
TanStack Router's automatic code splitting works by transforming your route files both during 'development' and at 'build' time. It rewrites the route definitions to use lazy-loading wrappers for components and loaders, which allows the bundler to group these properties into separate chunks.
> [!TIP]
> A **chunk** is a file that contains a portion of your application's code, which can be loaded on demand. This helps reduce the initial load time of your application by only loading the code that is needed for the current route.
So when your application loads, it doesn't include all the code for every route. Instead, it only includes the code for the routes that are initially needed. As users navigate through your application, additional chunks are loaded on demand.
This happens seamlessly, without requiring you to manually split your code or manage lazy loading. The TanStack Router bundler plugin takes care of everything, ensuring that your routes are optimized for performance right out of the box.
### The transformation process
When you enable automatic code splitting, the bundler plugin does this by using static code analysis look at your the code in your route files to transform them into optimized outputs.
This transformation process produces two key outputs when each of your route files are processed:
1. **Reference File**: The bundler plugin takes your original route file (e.g., \`posts.route.tsx\`) and modifies the values for properties like \`component\` or \`pendingComponent\` to use special lazy-loading wrappers that'll fetch the actual code later. These wrappers point to a "virtual" file that the bundler will resolve later on.
2. **Virtual File**: When the bundler sees a request for one of these virtual files (e.g., \`posts.route.tsx?tsr-split=component\`), it intercepts it to generate a new, minimal on-the-fly file that _only_ contains the code for the requested properties (e.g., just the \`PostsComponent\`).
This process ensures that your original code remains clean and readable, while the actual bundled output is optimized for initial bundle size.
### What gets code split?
The decision of what to split into separate chunks is crucial for optimizing your application's performance. TanStack Router uses a concept called "**Split Groupings**" to determine how different parts of your route should be bundled together.
Split groupings are arrays of properties that tell TanStack Router how to bundle different parts of your route together. Each grouping is an list of property names that you want to bundle together into a single lazy-loaded chunk.
The available properties to split are:
- \`component\`
- \`errorComponent\`
- \`pendingComponent\`
- \`notFoundComponent\`
- \`loader\`
By default, TanStack Router uses the following split groupings:
\`\`\`sh
[
['component'],
['errorComponent'],
['notFoundComponent']
]
\`\`\`
This means that it creates three separate lazy-loaded chunks for each route. Resulting in:
- One for the main component
- One for the error component
- And one for the not-found component.
### Rules of Splitting
For automatic code splitting to work, there are some rules in-place to make sure that this process can reliably and predictably happen.
#### Do not export route properties
Route properties like \`component\`, \`loader\`, etc., should not be exported from the route file. Exporting these properties results in them being bundled into the main application bundle, which means that they will not be code-split.
\`\`\`tsx
export const Route = createRoute('/posts')({
// ...
notFoundComponent: PostsNotFoundComponent,
})
// β Do NOT do this!
// Exporting the notFoundComponent will prevent it from being code-split
// and will be included in the main bundle.
export function PostsNotFoundComponent() {
// β
// ...
}
function PostsNotFoundComponent() {
// β
// ...
}
\`\`\`
**That's it!** There are no other restrictions. You can use any other JavaScript or TypeScript features in your route files as you normally would. If you run into any issues, please [open an issue](https://github.com/tanstack/router/issues) on GitHub.
## Granular control
For most applications, the default behavior of using \`autoCodeSplitting: true\` is sufficient. However, TanStack Router provides several options to customize how your routes are split into chunks, allowing you to optimize for specific use cases or performance needs.
### Global code splitting behavior (\`defaultBehavior\`)
You can change how TanStack Router splits your routes by changing the \`defaultBehavior\` option in your bundler plugin configuration. This allows you to define how different properties of your routes should be bundled together.
For example, to bundle all UI-related components into a single chunk, you could configure it like this:
\`\`\`ts title="vite.config.ts"
import { defineConfig } from 'vite'
import { tanstackRouter } from '@tanstack/router-plugin/vite'
export default defineConfig({
plugins: [
tanstackRouter({
autoCodeSplitting: true,
codeSplittingOptions: {
defaultBehavior: [
[
'component',
'pendingComponent',
'errorComponent',
'notFoundComponent',
], // Bundle all UI components together
],
},
}),
],
})
\`\`\`
### Advanced programmatic control (\`splitBehavior\`)
For complex rulesets, you can use the \`splitBehavior\` function in your vite config to programmatically define how routes should be split into chunks based on their \`routeId\`. This function allows you to implement custom logic for grouping properties together, giving you fine-grained control over the code splitting behavior.
\`\`\`ts title="vite.config.ts"
import { defineConfig } from 'vite'
import { tanstackRouter } from '@tanstack/router-plugin/vite'
export default defineConfig({
plugins: [
tanstackRouter({
autoCodeSplitting: true,
codeSplittingOptions: {
splitBehavior: ({ routeId }) => {
// For all routes under /posts, bundle the loader and component together
if (routeId.startsWith('/posts')) {
return [['loader', 'component']]
}
// All other routes will use the \`defaultBehavior\`
},
},
}),
],
})
\`\`\`
### Per-route overrides (\`codeSplitGroupings\`)
For ultimate control, you can override the global configuration directly inside a route file by adding a \`codeSplitGroupings\` property. This is useful for routes that have unique optimization needs.
\`\`\`tsx title="src/routes/posts.route.tsx"
import { loadPostsData } from './-heavy-posts-utils'
export const Route = createFileRoute('/posts')({
// For this specific route, bundle the loader and component together.
codeSplitGroupings: [['loader', 'component']],
loader: () => loadPostsData(),
component: PostsComponent,
})
function PostsComponent() {
// ...
}
\`\`\`
This will create a single chunk that includes both the \`loader\` and the \`component\` for this specific route, overriding both the default behavior and any programmatic split behavior defined in your bundler config.
### Configuration order matters
This guide has so far describe three different ways to configure how TanStack Router splits your routes into chunks.
To make sure that the different configurations do not conflict with each other, TanStack Router uses the following order of precedence:
1. **Per-route overrides**: The \`codeSplitGroupings\` property inside a route file takes the highest precedence. This allows you to define specific split groupings for individual routes.
2. **Programmatic split behavior**: The \`splitBehavior\` function in your bundler config allows you to define custom logic for how routes should be split based on their \`routeId\`.
3. **Default behavior**: The \`defaultBehavior\` option in your bundler config serves as the fallback for any routes that do not have specific overrides or custom logic defined. This is the base configuration that applies to all routes unless overridden.
### Splitting the Data Loader
The \`loader\` function is responsible for fetching data needed by the route. By default, it is bundled with into your "reference file" and loaded in the initial bundle. However, you can also split the \`loader\` into its own chunk if you want to optimize further.
> [!CAUTION]
> Moving the \`loader\` into its own chunk is a **performance trade-off**. It introduces an additional trip to the server before the data can be fetched, which can lead to slower initial page loads. This is because the \`loader\` **must** be fetched and executed before the route can render its component.
> Therefore, we recommend keeping the \`loader\` in the initial bundle unless you have a specific reason to split it.
\`\`\`ts
// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackRouter } from '@tanstack/router-plugin/vite'
export default defineConfig({
plugins: [
tanstackRouter({
autoCodeSplitting: true,
codeSplittingOptions: {
defaultBehavior: [
['loader'], // The loader will be in its own chunk
['component'],
// ... other component groupings
],
},
}),
],
})
\`\`\`
We highly discourage splitting the \`loader\` unless you have a specific use case that requires it. In most cases, not splitting off the \`loader\` and keep it in the main bundle is the best choice for performance.
# Code Splitting
Code splitting and lazy loading is a powerful technique for improving the bundle size and load performance of an application.
- Reduces the amount of code that needs to be loaded on initial page load
- Code is loaded on-demand when it is needed
- Results in more chunks that are smaller in size that can be cached more easily by the browser.
## How does TanStack Router split code?
TanStack Router separates code into two categories:
- **Critical Route Configuration** - The code that is required to render the current route and kick off the data loading process as early as possible.
- Path Parsing/Serialization
- Search Param Validation
- Loaders, Before Load
- Route Context
- Static Data
- Links
- Scripts
- Styles
- All other route configuration not listed below
- **Non-Critical/Lazy Route Configuration** - The code that is not required to match the route, and can be loaded on-demand.
- Route Component
- Error Component
- Pending Component
- Not-found Component
> π§ **Why is the loader not split?**
>
> - The loader is already an asynchronous boundary, so you pay double to both get the chunk _and_ wait for the loader to execute.
> - Categorically, it is less likely to contribute to a large bundle size than a component.
> - The loader is one of the most important preloadable assets for a route, especially if you're using a default preload intent, like hovering over a link, so it's important for the loader to be available without any additional async overhead.
>
> Knowing the disadvantages of splitting the loader, if you still want to go ahead with it, head over to the [Data Loader Splitting](#data-loader-splitting) section.
## Encapsulating a route's files into a directory
Since TanStack Router's file-based routing system is designed to support both flat and nested file structures, it's possible to encapsulate a route's files into a single directory without any additional configuration.
To encapsulate a route's files into a directory, move the route file itself into a \`.route\` file within a directory with the same name as the route file.
For example, if you have a route file named \`posts.tsx\`, you would create a new directory named \`posts\` and move the \`posts.tsx\` file into that directory, renaming it to \`route.tsx\`.
**Before**
- \`posts.tsx\`
**After**
- \`posts\`
- \`route.tsx\`
## Approaches to code splitting
TanStack Router supports multiple approaches to code splitting. If you are using code-based routing, skip to the [Code-Based Splitting](#code-based-splitting) section.
When you are using file-based routing, you can use the following approaches to code splitting:
- [Using automatic code-splitting β¨](#using-automatic-code-splitting)
- [Using the \`.lazy.tsx\` suffix](#using-the-lazytsx-suffix)
- [Using Virtual Routes](#using-virtual-routes)
## Using automatic code-splittingβ¨
This is the easiest and most powerful way to code split your route files.
When using the \`autoCodeSplitting\` feature, TanStack Router will automatically code split your route files based on the non-critical route configuration mentioned above.
> [!IMPORTANT]
> The automatic code-splitting feature is **ONLY** available when you are using file-based routing with one of our [supported bundlers](../routing/file-based-routing.md#getting-started-with-file-based-routing).
> This will **NOT** work if you are **only** using the CLI (\`@tanstack/router-cli\`).
To enable automatic code-splitting, you just need to add the following to the configuration of your TanStack Router Bundler Plugin:
\`\`\`ts
// vite.config.ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import { tanstackRouter } from '@tanstack/router-plugin/vite'
export default defineConfig({
plugins: [
tanstackRouter({
// ...
autoCodeSplitting: true,
}),
react(), // Make sure to add this plugin after the TanStack Router Bundler plugin
],
})
\`\`\`
That's it! TanStack Router will automatically code-split all your route files by their critical and non-critical route configurations.
If you want more control over the code-splitting process, head over to the [Automatic Code Splitting](./automatic-code-splitting.md) guide to learn more about the options available.
## Using the \`.lazy.tsx\` suffix
If you are not able to use the automatic code-splitting feature, you can still code-split your route files using the \`.lazy.tsx\` suffix. It is **as easy as moving your code into a separate file with a \`.lazy.tsx\` suffix** and using the \`createLazyFileRoute\` function instead of \`createFileRoute\`.
> [!IMPORTANT]
> The \`__root.tsx\` route file, using either \`createRootRoute\` or \`createRootRouteWithContext\`, does not support code splitting, since it's always rendered regardless of the current route.
These are the only options that \`createLazyFileRoute\` supports:
| Export Name | Description |
| ------------------- | --------------------------------------------------------------------- |
| \`component\` | The component to render for the route. |
| \`errorComponent\` | The component to render when an error occurs while loading the route. |
| \`pendingComponent\` | The component to render while the route is loading. |
| \`notFoundComponent\` | The component to render if a not-found error gets thrown. |
### Example code splitting with \`.lazy.tsx\`
When you are using \`.lazy.tsx\` you can split your route into two files to enable code splitting:
**Before (Single File)**
# React
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/react-router'
import { fetchPosts } from './api'
export const Route = createFileRoute('/posts')({
loader: fetchPosts,
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/solid-router'
import { fetchPosts } from './api'
export const Route = createFileRoute('/posts')({
loader: fetchPosts,
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
**After (Split into two files)**
This file would contain the critical route configuration:
# React
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/react-router'
import { fetchPosts } from './api'
export const Route = createFileRoute('/posts')({
loader: fetchPosts,
})
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/solid-router'
import { fetchPosts } from './api'
export const Route = createFileRoute('/posts')({
loader: fetchPosts,
})
\`\`\`
With the non-critical route configuration going into the file with the \`.lazy.tsx\` suffix:
# React
\`\`\`tsx title="src/routes/posts.lazy.tsx"
import { createLazyFileRoute } from '@tanstack/react-router'
export const Route = createLazyFileRoute('/posts')({
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.lazy.tsx"
import { createLazyFileRoute } from '@tanstack/solid-router'
export const Route = createLazyFileRoute('/posts')({
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
## Using Virtual Routes
You might run into a situation where you end up splitting out everything from a route file, leaving it empty! In this case, simply **delete the route file entirely**! A virtual route will automatically be generated for you to serve as an anchor for your code split files. This virtual route will live directly in the generated route tree file.
**Before (Virtual Routes)**
# React
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/react-router'
export const Route = createFileRoute('/posts')({
// Hello?
})
\`\`\`
\`\`\`tsx title="src/routes/posts.lazy.tsx"
import { createLazyFileRoute } from '@tanstack/react-router'
export const Route = createLazyFileRoute('/posts')({
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/solid-router'
export const Route = createFileRoute('/posts')({
// Hello?
})
\`\`\`
\`\`\`tsx title="src/routes/posts.lazy.tsx"
import { createLazyFileRoute } from '@tanstack/solid-router'
export const Route = createLazyFileRoute('/posts')({
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
**After (Virtual Routes)**
# React
\`\`\`tsx title="src/routes/posts.lazy.tsx"
import { createLazyFileRoute } from '@tanstack/react-router'
export const Route = createLazyFileRoute('/posts')({
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.lazy.tsx"
import { createLazyFileRoute } from '@tanstack/solid-router'
export const Route = createLazyFileRoute('/posts')({
component: Posts,
})
function Posts() {
// ...
}
\`\`\`
Tada! π
## Code-Based Splitting
If you are using code-based routing, you can still code-split your routes using the \`Route.lazy()\` method and the \`createLazyRoute\` function. You'll need to split your route configuration into two parts:
Create a lazy route using the \`createLazyRoute\` function.
\`\`\`tsx title="src/posts.lazy.tsx"
export const Route = createLazyRoute('/posts')({
component: MyComponent,
})
function MyComponent() {
return
My Component
}
\`\`\`
Then, call the \`.lazy\` method on the route definition in your \`app.tsx\` to import the lazy/code-split route with the non-critical route configuration.
\`\`\`tsx title="src/app.tsx"
const postsRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/posts',
}).lazy(() => import('./posts.lazy').then((d) => d.Route))
\`\`\`
## Data Loader Splitting
**Be warned!!!** Splitting a route loader is a dangerous game.
It can be a powerful tool to reduce bundle size, but it comes with a cost as mentioned in the [How does TanStack Router split code?](#how-does-tanstack-router-split-code) section.
You can code split your data loading logic using the Route's \`loader\` option. While this process makes it difficult to maintain type-safety with the parameters passed to your loader, you can always use the generic \`LoaderContext\` type to get you most of the way there:
# React
\`\`\`tsx
import { lazyFn } from '@tanstack/react-router'
const route = createRoute({
path: '/my-route',
component: MyComponent,
loader: lazyFn(() => import('./loader'), 'loader'),
})
// In another file...a
export const loader = async (context: LoaderContext) => {
/// ...
}
\`\`\`
# Solid
\`\`\`tsx
import { lazyFn } from '@tanstack/solid-router'
const route = createRoute({
path: '/my-route',
component: MyComponent,
loader: lazyFn(() => import('./loader'), 'loader'),
})
// In another file...a
export const loader = async (context: LoaderContext) => {
/// ...
}
\`\`\`
If you are using file-based routing, you'll only be able to split your \`loader\` if you are using [Automatic Code Splitting](#using-automatic-code-splitting) with customized bundling options.
## Manually accessing Route APIs in other files with the \`getRouteApi\` helper
As you might have guessed, placing your component code in a separate file than your route can make it difficult to consume the route itself. To help with this, TanStack Router exports a handy \`getRouteApi\` function that you can use to access a route's type-safe APIs in a file without importing the route itself.
# React
\`\`\`tsx title="src/my-route.tsx"
import { createRoute } from '@tanstack/react-router'
import { MyComponent } from './MyComponent'
const route = createRoute({
path: '/my-route',
loader: () => ({
foo: 'bar',
}),
component: MyComponent,
})
\`\`\`
\`\`\`tsx title="src/MyComponent.tsx"
import { getRouteApi } from '@tanstack/react-router'
const route = getRouteApi('/my-route')
export function MyComponent() {
const loaderData = route.useLoaderData()
// ^? { foo: string }
return
}
\`\`\`
The \`getRouteApi\` function is useful for accessing other type-safe APIs:
- \`useLoaderData\`
- \`useLoaderDeps\`
- \`useMatch\`
- \`useParams\`
- \`useRouteContext\`
- \`useSearch\`
# Creating a Router
## The \`createRouter\` function
When you're ready to start using your router, you'll need to create a new \`Router\` instance. The router instance is the core brains of TanStack Router and is responsible for managing the route tree, matching routes, and coordinating navigations and route transitions. It also serves as a place to configure router-wide settings.
# React
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/react-router'
const router = createRouter({
// ...
})
\`\`\`
# Solid
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/solid-router'
const router = createRouter({
// ...
})
\`\`\`
## Route Tree
You'll probably notice quickly that the \`Router\` constructor requires a \`routeTree\` option. This is the route tree that the router will use to match routes and render components.
Whether you used [file-based routing](../routing/file-based-routing.md) or [code-based routing](../routing/code-based-routing.md), you'll need to pass your route tree to the \`createRouter\` function:
### Filesystem Route Tree
If you used our recommended file-based routing, then it's likely your generated route tree file was created at the default \`src/routeTree.gen.ts\` location. If you used a custom location, then you'll need to import your route tree from that location.
\`\`\`tsx
import { routeTree } from './routeTree.gen'
\`\`\`
### Code-Based Route Tree
If you used code-based routing, then you likely created your route tree manually using the root route's \`addChildren\` method:
\`\`\`tsx
const routeTree = rootRoute.addChildren([
// ...
])
\`\`\`
## Router Type Safety
> [!IMPORTANT]
> DO NOT SKIP THIS SECTION! β οΈ
TanStack Router provides amazing support for TypeScript, even for things you wouldn't expect like bare imports straight from the library! To make this possible, you must register your router's types using TypeScripts' [Declaration Merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) feature. This is done by extending the \`Register\` interface on \`@tanstack/react-router\` with a \`router\` property that has the type of your \`router\` instance:
# React
\`\`\`tsx title="src/router.tsx"
declare module '@tanstack/react-router' {
interface Register {
// This infers the type of our router and registers it across your entire project
router: typeof router
}
}
\`\`\`
# Solid
\`\`\`tsx title="src/router.tsx"
declare module '@tanstack/solid-router' {
interface Register {
// This infers the type of our router and registers it across your entire project
router: typeof router
}
}
\`\`\`
With your router registered, you'll now get type-safety across your entire project for anything related to routing.
## 404 Not Found Route
As promised in earlier guides, we'll now cover the \`notFoundRoute\` option. This option is used to configure a route that will render when no other suitable match is found. This is useful for rendering a 404 page or redirecting to a default route.
If you are using either file-based or code-based routing, then you'll need to add a \`notFoundComponent\` key to \`createRootRoute\`:
\`\`\`tsx
export const Route = createRootRoute({
component: () => (
// ...
),
notFoundComponent: () =>
404 Not Found
,
});
\`\`\`
## Other Options
There are many other options that can be passed to the \`Router\` constructor. You can find a full list of them in the [API Reference](../api/router/RouterOptionsType.md).
# Custom Link
While repeating yourself can be acceptable in many situations, you might find that you do it too often. At times, you may want to create cross-cutting components with additional behavior or styles. You might also consider using third-party libraries in combination with TanStack Router's type safety.
## \`createLink\` for cross-cutting concerns
\`createLink\` creates a custom \`Link\` component with the same type parameters as \`Link\`. This means you can create your own component which provides the same type safety and typescript performance as \`Link\`.
### Basic example
If you want to create a basic custom link component, you can do so with the following:
# React
\`\`\`tsx
import * as React from 'react'
import { createLink, LinkComponent } from '@tanstack/react-router'
interface BasicLinkProps extends React.AnchorHTMLAttributes {
// Add any additional props you want to pass to the anchor element
}
const BasicLinkComponent = React.forwardRef(
(props, ref) => {
return (
)
},
)
const CreatedLinkComponent = createLink(BasicLinkComponent)
export const CustomLink: LinkComponent = (props) => {
return
}
\`\`\`
# Solid
\`\`\`tsx
import * as Solid from 'solid-js'
import { createLink, LinkComponent } from '@tanstack/solid-router'
export const Route = createRootRoute({
component: RootComponent,
})
type BasicLinkProps = Solid.JSX.IntrinsicElements['a'] & {
// Add any additional props you want to pass to the anchor element
}
const BasicLinkComponent: Solid.Component = (props) => (
{props.children}
)
const CreatedLinkComponent = createLink(BasicLinkComponent)
export const CustomLink: LinkComponent = (props) => {
return
}
\`\`\`
You can then use your newly created \`Link\` component as any other \`Link\`
\`\`\`tsx
\`\`\`
## \`createLink\` with third party libraries
Here are some examples of how you can use \`createLink\` with third-party libraries.
# React
### React Aria Components example
React Aria Components v1.11.0 and later works with TanStack Router's \`preload (intent)\` prop. Use \`createLink\` to wrap each React Aria component that you use as a link.
\`\`\`tsx title="RACLink.tsx"
import { createLink } from '@tanstack/react-router'
import { Link as RACLink, MenuItem } from 'react-aria-components'
export const Link = createLink(RACLink)
export const MenuItemLink = createLink(MenuItem)
\`\`\`
\`\`\`tsx title="CustomRACLink.tsx"
import { createLink } from '@tanstack/react-router'
import { Link as RACLink, type LinkProps } from 'react-aria-components'
interface MyLinkProps extends LinkProps {
// your props
}
function MyLink(props: MyLinkProps) {
return (
({
color: isHovered ? 'red' : 'blue',
})}
/>
)
}
export const Link = createLink(MyLink)
\`\`\`
To use React Aria's render props, including the \`className\`, \`style\`, and \`children\` functions, create a wrapper component and pass that to \`createLink\`.
# React
### Chakra UI example
\`\`\`tsx title="ChakraLinkComponent.tsx"
import * as React from 'react'
import { createLink, LinkComponent } from '@tanstack/react-router'
import { Link } from '@chakra-ui/react'
interface ChakraLinkProps extends Omit<
React.ComponentPropsWithoutRef,
'href'
> {
// Add any additional props you want to pass to the link
}
const ChakraLinkComponent = React.forwardRef<
HTMLAnchorElement,
ChakraLinkProps
>((props, ref) => {
return
})
const CreatedLinkComponent = createLink(ChakraLinkComponent)
export const CustomLink: LinkComponent = (
props,
) => {
return (
)
}
\`\`\`
# React
### MUI example
There is an [example](https://github.com/TanStack/router/tree/main/examples/react/start-material-ui) available which uses these patterns.
#### \`Link\`
If the MUI \`Link\` should simply behave like the router \`Link\`, it can be just wrapped with \`createLink\`:
\`\`\`tsx title="CustomLink.tsx"
import { createLink } from '@tanstack/react-router'
import { Link } from '@mui/material'
export const CustomLink = createLink(Link)
\`\`\`
If the \`Link\` should be customized this approach can be used:
\`\`\`tsx title="CustomLink.tsx"
import React from 'react'
import { createLink } from '@tanstack/react-router'
import { Link } from '@mui/material'
import type { LinkProps } from '@mui/material'
import type { LinkComponent } from '@tanstack/react-router'
interface MUILinkProps extends LinkProps {
// Add any additional props you want to pass to the Link
}
const MUILinkComponent = React.forwardRef(
(props, ref) => ,
)
const CreatedLinkComponent = createLink(MUILinkComponent)
export const CustomLink: LinkComponent = (props) => {
return
}
// Can also be styled
\`\`\`
#### \`Button\`
If a \`Button\` should be used as a router \`Link\`, the \`component\` should be set as \`a\`:
\`\`\`tsx title="CustomButtonLink.tsx"
import React from 'react'
import { createLink } from '@tanstack/react-router'
import { Button } from '@mui/material'
import type { ButtonProps } from '@mui/material'
import type { LinkComponent } from '@tanstack/react-router'
interface MUIButtonLinkProps extends ButtonProps<'a'> {
// Add any additional props you want to pass to the Button
}
const MUIButtonLinkComponent = React.forwardRef<
HTMLAnchorElement,
MUIButtonLinkProps
>((props, ref) => )
const CreatedButtonLinkComponent = createLink(MUIButtonLinkComponent)
export const CustomButtonLink: LinkComponent = (
props,
) => {
return
}
\`\`\`
#### Usage with \`styled\`
Any of these MUI approaches can then be used with \`styled\`:
\`\`\`tsx title="StyledCustomLink.tsx"
import { css, styled } from '@mui/material'
import { CustomLink } from './CustomLink'
const StyledCustomLink = styled(CustomLink)(
({ theme }) => css\`
color: \${theme.palette.common.white};
\`,
)
\`\`\`
# React
### Mantine example
\`\`\`tsx title="CustomLink.tsx"
import * as React from 'react'
import { createLink, LinkComponent } from '@tanstack/react-router'
import { Anchor, AnchorProps } from '@mantine/core'
interface MantineAnchorProps extends Omit {
// Add any additional props you want to pass to the anchor
}
const MantineLinkComponent = React.forwardRef<
HTMLAnchorElement,
MantineAnchorProps
>((props, ref) => {
return
})
const CreatedLinkComponent = createLink(MantineLinkComponent)
export const CustomLink: LinkComponent = (
props,
) => {
return
}
\`\`\`
# Solid
### Some Library example
\`\`\`tsx title="UntitledLink.tsx"
// TODO: Add this example.
\`\`\`
# Custom Search Param Serialization
By default, TanStack Router parses and serializes your URL Search Params automatically using \`JSON.stringify\` and \`JSON.parse\`. This process involves escaping and unescaping the search string, which is a common practice for URL search params, in addition to the serialization and deserialization of the search object.
For instance, using the default configuration, if you have the following search object:
\`\`\`tsx
const search = {
page: 1,
sort: 'asc',
filters: { author: 'tanner', min_words: 800 },
}
\`\`\`
It would be serialized and escaped into the following search string:
\`\`\`txt
?page=1&sort=asc&filters=%7B%22author%22%3A%22tanner%22%2C%22min_words%22%3A800%7D
\`\`\`
We can implement the default behavior with the following code:
# React
\`\`\`tsx
import {
createRouter,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/react-router'
const router = createRouter({
// ...
parseSearch: parseSearchWith(JSON.parse),
stringifySearch: stringifySearchWith(JSON.stringify),
})
\`\`\`
# Solid
\`\`\`tsx
import {
createRouter,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/solid-router'
const router = createRouter({
// ...
parseSearch: parseSearchWith(JSON.parse),
stringifySearch: stringifySearchWith(JSON.stringify),
})
\`\`\`
However, this default behavior may not be suitable for all use cases. For example, you may want to use a different serialization format, such as base64 encoding, or you may want to use a purpose-built serialization/deserialization library, like [query-string](https://github.com/sindresorhus/query-string), [JSURL2](https://github.com/wmertens/jsurl2), or [Zipson](https://jgranstrom.github.io/zipson/).
This can be achieved by providing your own serialization and deserialization functions to the \`parseSearch\` and \`stringifySearch\` options in the [\`Router\`](../api/router/RouterOptionsType.md#stringifysearch-method) configuration. When doing this, you can utilize TanStack Router's built-in helper functions, \`parseSearchWith\` and \`stringifySearchWith\`, to simplify the process.
> [!TIP]
> An important aspect of serialization and deserialization, is that you are able to get the same object back after deserialization. This is important because if the serialization and deserialization process is not done correctly, you may lose some information. For example, if you are using a library that does not support nested objects, you may lose the nested object when deserializing the search string.
Here are some examples of how you can customize the search param serialization in TanStack Router:
## Using Base64
It's common to base64 encode your search params to achieve maximum compatibility across browsers and URL unfurlers, etc. This can be done with the following code:
# React
\`\`\`tsx
import {
Router,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/react-router'
const router = createRouter({
parseSearch: parseSearchWith((value) => JSON.parse(decodeFromBinary(value))),
stringifySearch: stringifySearchWith((value) =>
encodeToBinary(JSON.stringify(value)),
),
})
function decodeFromBinary(str: string): string {
return decodeURIComponent(
Array.prototype.map
.call(atob(str), function (c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2)
})
.join(''),
)
}
function encodeToBinary(str: string): string {
return btoa(
encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, function (match, p1) {
return String.fromCharCode(parseInt(p1, 16))
}),
)
}
\`\`\`
# Solid
\`\`\`tsx
import {
Router,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/solid-router'
const router = createRouter({
parseSearch: parseSearchWith((value) => JSON.parse(decodeFromBinary(value))),
stringifySearch: stringifySearchWith((value) =>
encodeToBinary(JSON.stringify(value)),
),
})
function decodeFromBinary(str: string): string {
return decodeURIComponent(
Array.prototype.map
.call(atob(str), function (c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2)
})
.join(''),
)
}
function encodeToBinary(str: string): string {
return btoa(
encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, function (match, p1) {
return String.fromCharCode(parseInt(p1, 16))
}),
)
}
\`\`\`
> [β οΈ Why does this snippet not use atob/btoa?](#safe-binary-encodingdecoding)
So, if we were to turn the previous object into a search string using this configuration, it would look like this:
\`\`\`txt
?page=1&sort=asc&filters=eyJhdXRob3IiOiJ0YW5uZXIiLCJtaW5fd29yZHMiOjgwMH0%3D
\`\`\`
> [!WARNING]
> If you are serializing user input into Base64, you run the risk of causing a collision with the URL deserialization. This can lead to unexpected behavior, such as the URL not being parsed correctly or being interpreted as a different value. To avoid this, you should encode the search params using a safe binary encoding/decoding method (see below).
## Using the query-string library
The [query-string](https://github.com/sindresorhus/query-string) library is a popular for being able to reliably parse and stringify query strings. You can use it to customize the serialization format of your search params. This can be done with the following code:
# React
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
import qs from 'query-string'
const router = createRouter({
// ...
stringifySearch: stringifySearchWith((value) =>
qs.stringify(value, {
// ...options
}),
),
parseSearch: parseSearchWith((value) =>
qs.parse(value, {
// ...options
}),
),
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouter } from '@tanstack/solid-router'
import qs from 'query-string'
const router = createRouter({
// ...
stringifySearch: stringifySearchWith((value) =>
qs.stringify(value, {
// ...options
}),
),
parseSearch: parseSearchWith((value) =>
qs.parse(value, {
// ...options
}),
),
})
\`\`\`
So, if we were to turn the previous object into a search string using this configuration, it would look like this:
\`\`\`txt
?page=1&sort=asc&filters=author%3Dtanner%26min_words%3D800
\`\`\`
## Using the JSURL2 library
[JSURL2](https://github.com/wmertens/jsurl2) is a non-standard library that can compress URLs while still maintaining readability. This can be done with the following code:
# React
\`\`\`tsx
import {
Router,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/react-router'
import { parse, stringify } from 'jsurl2'
const router = createRouter({
// ...
parseSearch: parseSearchWith(parse),
stringifySearch: stringifySearchWith(stringify),
})
\`\`\`
# Solid
\`\`\`tsx
import {
Router,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/solid-router'
import { parse, stringify } from 'jsurl2'
const router = createRouter({
// ...
parseSearch: parseSearchWith(parse),
stringifySearch: stringifySearchWith(stringify),
})
\`\`\`
So, if we were to turn the previous object into a search string using this configuration, it would look like this:
\`\`\`txt
?page=1&sort=asc&filters=(author~tanner~min*_words~800)~
\`\`\`
## Using the Zipson library
[Zipson](https://jgranstrom.github.io/zipson/) is a very user-friendly and performant JSON compression library (both in runtime performance and the resulting compression performance). To compress your search params with it (which requires escaping/unescaping and base64 encoding/decoding them as well), you can use the following code:
# React
\`\`\`tsx
import {
Router,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/react-router'
import { stringify, parse } from 'zipson'
const router = createRouter({
parseSearch: parseSearchWith((value) => parse(decodeFromBinary(value))),
stringifySearch: stringifySearchWith((value) =>
encodeToBinary(stringify(value)),
),
})
function decodeFromBinary(str: string): string {
return decodeURIComponent(
Array.prototype.map
.call(atob(str), function (c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2)
})
.join(''),
)
}
function encodeToBinary(str: string): string {
return btoa(
encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, function (match, p1) {
return String.fromCharCode(parseInt(p1, 16))
}),
)
}
\`\`\`
# Solid
\`\`\`tsx
import {
Router,
parseSearchWith,
stringifySearchWith,
} from '@tanstack/solid-router'
import { stringify, parse } from 'zipson'
const router = createRouter({
parseSearch: parseSearchWith((value) => parse(decodeFromBinary(value))),
stringifySearch: stringifySearchWith((value) =>
encodeToBinary(stringify(value)),
),
})
function decodeFromBinary(str: string): string {
return decodeURIComponent(
Array.prototype.map
.call(atob(str), function (c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2)
})
.join(''),
)
}
function encodeToBinary(str: string): string {
return btoa(
encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, function (match, p1) {
return String.fromCharCode(parseInt(p1, 16))
}),
)
}
\`\`\`
> [β οΈ Why does this snippet not use atob/btoa?](#safe-binary-encodingdecoding)
So, if we were to turn the previous object into a search string using this configuration, it would look like this:
\`\`\`txt
?page=1&sort=asc&filters=JTdCJUMyJUE4YXV0aG9yJUMyJUE4JUMyJUE4dGFubmVyJUMyJUE4JUMyJUE4bWluX3dvcmRzJUMyJUE4JUMyJUEyQ3UlN0Q%3D
\`\`\`
## Safe Binary Encoding/Decoding
In the browser, the \`atob\` and \`btoa\` functions are not guaranteed to work properly with non-UTF8 characters. We recommend using these encoding/decoding utilities instead:
To encode from a string to a binary string:
\`\`\`ts
export function encodeToBinary(str: string): string {
return btoa(
encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, function (match, p1) {
return String.fromCharCode(parseInt(p1, 16))
}),
)
}
\`\`\`
To decode from a binary string to a string:
\`\`\`ts
export function decodeFromBinary(str: string): string {
return decodeURIComponent(
Array.prototype.map
.call(atob(str), function (c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2)
})
.join(''),
)
}
\`\`\`
# Data Loading
Data loading is a common concern for web applications and is related to routing. When loading a page for your app, it's ideal if all of the page's async requirements are fetched and fulfilled as early as possible, in parallel. The router is the best place to coordinate these async dependencies as it's usually the only place in your app that knows where users are headed before content is rendered.
You may be familiar with \`getServerSideProps\` from Next.js or \`loader\`s from Remix/React-Router. TanStack Router has similar functionality to preload/load assets on a per-route basis in parallel allowing it to render as quickly as possible as it fetches via suspense.
Beyond these normal expectations of a router, TanStack Router goes above and beyond and provides **built-in SWR Caching**, a long-term in-memory caching layer for route loaders. This means that you can use TanStack Router to both preload data for your routes so they load instantaneously or temporarily cache route data for previously visited routes to use again later.
## The route loading lifecycle
Every time a URL/history update is detected, the router executes the following sequence:
- Route Matching (Top-Down)
- \`route.params.parse\`
- \`route.validateSearch\`
- Route Pre-Loading (Serial)
- \`route.beforeLoad\`
- \`route.onError\`
- \`route.errorComponent\` / \`parentRoute.errorComponent\` / \`router.defaultErrorComponent\`
- Route Loading (Parallel)
- \`route.component.preload?\`
- \`route.loader\`
- \`route.pendingComponent\` (Optional)
- \`route.component\`
- \`route.onError\`
- \`route.errorComponent\` / \`parentRoute.errorComponent\` / \`router.defaultErrorComponent\`
## To Router Cache or not to Router Cache?
There is a high possibility that TanStack's router cache will be a good fit for most smaller to medium size applications, but it's important to understand the tradeoffs of using it vs a more robust caching solution like TanStack Query:
TanStack Router Cache Pros:
- Built-in, easy to use, no extra dependencies
- Handles deduping, preloading, loading, stale-while-revalidate, background refetching on a per-route basis
- Coarse invalidation (invalidate all routes and cache at once)
- Automatic garbage collection
- Works great for apps that share little data between routes
- "Just works" for SSR
TanStack Router Cache Cons:
- No persistence adapters/model
- No shared caching/deduping between routes
- No built-in mutation APIs (a basic \`useMutation\` hook is provided in many examples that may be sufficient for many use cases)
- No built-in cache-level optimistic update APIs (you can still use ephemeral state from something like a \`useMutation\` hook to achieve this at the component level)
> [!TIP]
> If you know right away that you'd like to or need to use something more robust like TanStack Query, skip to the [External Data Loading](./external-data-loading.md) guide.
## Using the Router Cache
The router cache is built-in and is as easy as returning data from any route's \`loader\` function. Let's learn how!
## Route \`loader\`s
Route \`loader\` functions are called when a route match is loaded. They are called with a single parameter which is an object containing many helpful properties. We'll go over those in a bit, but first, let's look at the two supported \`loader\` forms:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
})
\`\`\`
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: {
handler: () => fetchPosts(),
},
})
\`\`\`
Use the object form when you want to configure loader-specific behavior such as \`staleReloadMode\`.
## \`loader\` Parameters
The \`loader\` function receives a single object with the following properties:
- \`abortController\` - The route's abortController. Its signal is cancelled when the route is unloaded or when the Route is no longer relevant and the current invocation of the \`loader\` function becomes outdated.
- \`cause\` - The cause of the current route match. Can be either one of the following:
- \`enter\` - When the route is matched and loaded after not being matched in the previous location.
- \`preload\` - When the route is being preloaded.
- \`stay\` - When the route is matched and loaded after being matched in the previous location.
- \`context\` - The route's context object, which is a merged union of:
- Parent route context
- This route's context as provided by the \`beforeLoad\` option
- \`deps\` - The object value returned from the \`Route.loaderDeps\` function. If \`Route.loaderDeps\` is not defined, an empty object will be provided instead.
- \`location\` - The current location
- \`params\` - The route's path params
- \`parentMatchPromise\` - \`Promise\` (\`undefined\` for the root route)
- \`preload\` - Boolean which is \`true\` when the route is being preloaded instead of loaded
- \`route\` - The route itself
Using these parameters, we can do a lot of cool things, but first, let's take a look at how we can control it and when the \`loader\` function is called.
## Consuming data from \`loader\`s
To consume data from a \`loader\`, use the \`useLoaderData\` hook defined on your Route object.
\`\`\`tsx
const posts = Route.useLoaderData()
\`\`\`
If you don't have ready access to your route object (i.e. you're deep in the component tree for the current route), you can use \`getRouteApi\` to access the same hook (as well as the other hooks on the Route object). This should be preferred over importing the Route object, which is likely to create circular dependencies.
# React
\`\`\`tsx
import { getRouteApi } from '@tanstack/react-router'
// in your component
const routeApi = getRouteApi('/posts')
const data = routeApi.useLoaderData()
\`\`\`
# Solid
\`\`\`tsx
import { getRouteApi } from '@tanstack/solid-router'
// in your component
const routeApi = getRouteApi('/posts')
const data = routeApi.useLoaderData()
\`\`\`
## Dependency-based Stale-While-Revalidate Caching
TanStack Router provides a built-in Stale-While-Revalidate caching layer for route loaders that is keyed on the dependencies of a route:
- The route's fully parsed pathname
- e.g. \`/posts/1\` vs \`/posts/2\`
- Any additional dependencies provided by the \`loaderDeps\` option
- e.g. \`loaderDeps: ({ search: { pageIndex, pageSize } }) => ({ pageIndex, pageSize })\`
Using these dependencies as keys, TanStack Router will cache the data returned from a route's \`loader\` function and use it to fulfill subsequent requests for the same route match. This means that if a route's data is already in the cache, it will be returned immediately, then **potentially** be refetched in the background depending on the "freshness" of the data.
### Key options
To control router dependencies and "freshness", TanStack Router provides a plethora of options to control the keying and caching behavior of your route loaders. Let's take a look at them in the order that you are most likely to use them:
- \`routeOptions.loaderDeps\`
- A function that supplies you the search params for a router and returns an object of dependencies for use in your \`loader\` function. When these deps changed from navigation to navigation, it will cause the route to reload regardless of \`staleTime\`s. The deps are compared using a deep equality check.
- \`routeOptions.staleTime\`
- \`routerOptions.defaultStaleTime\`
- The number of milliseconds that a route's data should be considered fresh when attempting to load.
- \`routeOptions.preloadStaleTime\`
- \`routerOptions.defaultPreloadStaleTime\`
- The number of milliseconds that a route's data should be considered fresh attempting to preload.
- \`routeOptions.gcTime\`
- \`routerOptions.defaultGcTime\`
- The number of milliseconds that a route's data should be kept in the cache before being garbage collected.
- \`routeOptions.shouldReload\`
- A function that receives the same \`beforeLoad\` and \`loaderContext\` parameters and returns a boolean indicating if the route should reload. This offers one more level of control over when a route should reload beyond \`staleTime\` and \`loaderDeps\` and can be used to implement patterns similar to Remix's \`shouldLoad\` option.
- \`routeOptions.loader.staleReloadMode\`
- \`routerOptions.defaultStaleReloadMode\`
- Controls what happens when a matched route already has stale successful data. Use \`'background'\` for stale-while-revalidate, or \`'blocking'\` to wait for the stale loader reload to finish before continuing.
### β οΈ Some Important Defaults
- By default, the \`staleTime\` is set to \`0\`, meaning that the route's data is immediately considered stale. Stale matches are reloaded in the background when the route is entered again, when its loader key changes (path params used by the route or \`loaderDeps\`), or when \`router.load()\` is called explicitly.
- By default, a previously preloaded route is considered fresh for **30 seconds**. This means if a route is preloaded, then preloaded again within 30 seconds, the second preload will be ignored. This prevents unnecessary preloads from happening too frequently. **When a route is loaded normally, the standard \`staleTime\` is used.**
- By default, the \`gcTime\` is set to **30 minutes**, meaning that any route data that has not been accessed in 30 minutes will be garbage collected and removed from the cache.
- By default, \`staleReloadMode\` is \`'background'\`, so stale successful matches keep rendering with their existing \`loaderData\` while the loader revalidates in the background.
- \`router.invalidate()\` will force all active routes to reload their loaders immediately and mark every cached route's data as stale.
### Using \`loaderDeps\` to access search params
Imagine a \`/posts\` route supports some pagination via search params \`offset\` and \`limit\`. For the cache to uniquely store this data, we need to access these search params via the \`loaderDeps\` function. By explicitly identifying them, each route match for \`/posts\` with different \`offset\` and \`limit\` won't get mixed up!
Once we have these deps in place, the route will always reload when the deps change.
\`\`\`tsx
// /routes/posts.tsx
export const Route = createFileRoute('/posts')({
loaderDeps: ({ search: { offset, limit } }) => ({ offset, limit }),
loader: ({ deps: { offset, limit } }) =>
fetchPosts({
offset,
limit,
}),
})
\`\`\`
> [!WARNING]
> **Only include dependencies you actually use in the loader.**
>
> A common mistake is returning the entire \`search\` object:
>
> \`\`\`tsx
> // β Don't do this - causes unnecessary cache invalidation
> loaderDeps: ({ search }) => search,
> loader: ({ deps }) => fetchPosts({ page: deps.page }), // only uses page!
> \`\`\`
>
> This causes the route to reload whenever ANY search param changes, even params not used in the loader (like \`viewMode\` or \`sortDirection\`). Instead, extract only what you need:
>
> \`\`\`tsx
> // β Do this - only reload when used params change
> loaderDeps: ({ search }) => ({
> page: search.page,
> limit: search.limit,
> }),
> loader: ({ deps }) => fetchPosts(deps),
> \`\`\`
### Using \`staleTime\` to control how long data is considered fresh
By default, \`staleTime\` for navigations is set to \`0\`ms (and 30 seconds for preloads) which means that the route's data will always be considered stale. When a stale route is entered again, its loader key changes, or \`router.load()\` is called explicitly, the route will reload in the background.
**This is a good default for most use cases, but you may find that some route data is more static or potentially expensive to load.** In these cases, you can use the \`staleTime\` option to control how long the route's data is considered fresh for navigations. Let's take a look at an example:
\`\`\`tsx
// /routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
// Consider the route's data fresh for 10 seconds
staleTime: 10_000,
})
\`\`\`
By passing \`10_000\` to the \`staleTime\` option, we are telling the router to consider the route's data fresh for 10 seconds. This means that if the user navigates to \`/posts\` from \`/about\` within 10 seconds of the last loader result, the route's data will not be reloaded. If the user then navigates to \`/posts\` from \`/about\` after 10 seconds, the route's data will be reloaded **in the background**.
## Choosing background vs blocking stale reloads
By default, stale successful matches use stale-while-revalidate behavior. That means the router can render with the existing \`loaderData\` immediately and then refresh it in the background.
If you want a specific loader to wait for a stale reload to finish before continuing, use the object form and set \`staleReloadMode: 'blocking'\`:
\`\`\`tsx
// /routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: {
handler: () => fetchPosts(),
staleReloadMode: 'blocking',
},
})
\`\`\`
You can also change the default for the entire router:
\`\`\`tsx
const router = createRouter({
routeTree,
defaultStaleReloadMode: 'blocking',
})
\`\`\`
Use \`'background'\` when showing stale data during revalidation is acceptable. Use \`'blocking'\` when you want stale matches to behave more like a fresh load and wait for the new loader result.
## Turning off automatic stale reloads
To disable automatic stale reloads for a route, set the \`staleTime\` option to \`Infinity\`:
\`\`\`tsx
// /routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
staleTime: Infinity,
})
\`\`\`
You can even turn this off for all routes by setting the \`defaultStaleTime\` option on the router:
\`\`\`tsx
const router = createRouter({
routeTree,
defaultStaleTime: Infinity,
})
\`\`\`
This differs from \`staleReloadMode: 'blocking'\`:
- \`staleTime: Infinity\` prevents the route from becoming stale in the first place
- \`staleReloadMode: 'blocking'\` still allows stale reloads, but waits for them instead of doing them in the background
## Using \`shouldReload\` and \`gcTime\` to opt-out of caching
Similar to Remix's default functionality, you may want to configure a route to only load on entry or when critical loader deps change. You can do this by using the \`gcTime\` option combined with the \`shouldReload\` option, which accepts either a \`boolean\` or a function that receives the same \`beforeLoad\` and \`loaderContext\` parameters and returns a boolean indicating if the route should reload.
\`\`\`tsx
// /routes/posts.tsx
export const Route = createFileRoute('/posts')({
loaderDeps: ({ search: { offset, limit } }) => ({ offset, limit }),
loader: ({ deps }) => fetchPosts(deps),
// Do not cache this route's data after it's unloaded
gcTime: 0,
// Only reload the route when the user navigates to it or when deps change
shouldReload: false,
})
\`\`\`
### Opting out of caching while still preloading
Even though you may opt-out of short-term caching for your route data, you can still get the benefits of preloading! With the above configuration, preloading will still "just work" with the default \`preloadGcTime\`. This means that if a route is preloaded, then navigated to, the route's data will be considered fresh and will not be reloaded.
To opt out of preloading, don't turn it on via the \`routerOptions.defaultPreload\` or \`routeOptions.preload\` options.
## Passing all loader events to an external cache
We break down this use case in the [External Data Loading](./external-data-loading.md) page, but if you'd like to use an external cache like TanStack Query, you can do so by passing all loader events to your external cache. As long as you are using the defaults, the only change you'll need to make is to set the \`defaultPreloadStaleTime\` option on the router to \`0\`:
\`\`\`tsx
const router = createRouter({
routeTree,
defaultPreloadStaleTime: 0,
})
\`\`\`
This will ensure that every preload, load, and reload event will trigger your \`loader\` functions, which can then be handled and deduped by your external cache.
## Using Router Context
The \`context\` argument passed to the \`loader\` function is an object containing a merged union of:
- Parent route context
- This route's context as provided by the \`beforeLoad\` option
Starting at the very top of the router, you can pass an initial context to the router via the \`context\` option. This context will be available to all routes in the router and get copied and extended by each route as they are matched. This happens by passing a context to a route via the \`beforeLoad\` option. This context will be available to all the route's child routes. The resulting context will be available to the route's \`loader\` function.
In this example, we'll create a function in our route context to fetch posts, then use it in our \`loader\` function.
> π§ Context is a powerful tool for dependency injection. You can use it to inject services, hooks, and other objects into your router and routes. You can also additively pass data down the route tree at every route using a route's \`beforeLoad\` option.
- \`/utils/fetchPosts.tsx\`
\`\`\`tsx
export const fetchPosts = async () => {
const res = await fetch(\`/api/posts?page=\${pageIndex}\`)
if (!res.ok) throw new Error('Failed to fetch posts')
return res.json()
}
\`\`\`
- \`/routes/__root.tsx\`
# React
\`\`\`tsx
import { createRootRouteWithContext } from '@tanstack/react-router'
// Create a root route using the createRootRouteWithContext<{...}>() function and pass it whatever types you would like to be available in your router context.
export const Route = createRootRouteWithContext<{
fetchPosts: typeof fetchPosts
}>()() // NOTE: the double call is on purpose, since createRootRouteWithContext is a factory ;)
\`\`\`
# Solid
\`\`\`tsx
import { createRootRouteWithContext } from '@tanstack/solid-router'
// Create a root route using the createRootRouteWithContext<{...}>() function and pass it whatever types you would like to be available in your router context.
export const Route = createRootRouteWithContext<{
fetchPosts: typeof fetchPosts
}>()() // NOTE: the double call is on purpose, since createRootRouteWithContext is a factory ;)
\`\`\`
- \`/routes/posts.tsx\`
\`\`\`tsx
// Notice how our postsRoute references context to get our fetchPosts function
// This can be a powerful tool for dependency injection across your router
// and routes.
export const Route = createFileRoute('/posts')({
loader: ({ context: { fetchPosts } }) => fetchPosts(),
})
\`\`\`
- \`/router.tsx\`
\`\`\`tsx
import { routeTree } from './routeTree.gen'
// Use your routerContext to create a new router
// This will require that you fullfil the type requirements of the routerContext
const router = createRouter({
routeTree,
context: {
// Supply the fetchPosts function to the router context
fetchPosts,
},
})
\`\`\`
## Using Path Params
To use path params in your \`loader\` function, access them via the \`params\` property on the function's parameters. Here's an example:
\`\`\`tsx
// src/routes/posts.$postId.tsx
export const Route = createFileRoute('/posts/$postId')({
loader: ({ params: { postId } }) => fetchPostById(postId),
})
\`\`\`
## Using Route Context
Passing down global context to your router is great, but what if you want to provide context that is specific to a route? This is where the \`beforeLoad\` option comes in. The \`beforeLoad\` option is a function that runs right before attempting to load a route and receives the same parameters as \`loader\`. Beyond its ability to redirect potential matches, block loader requests, etc, it can also return an object that will be merged into the route's context. Let's take a look at an example where we inject some data into our route context via the \`beforeLoad\` option:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
// Pass the fetchPosts function to the route context
beforeLoad: () => ({
fetchPosts: () => console.info('foo'),
}),
loader: ({ context: { fetchPosts } }) => {
fetchPosts() // 'foo'
// ...
},
})
\`\`\`
## Using Search Params in Loaders
> β But wait Tanner... where the heck are my search params?!
You might be here wondering why \`search\` isn't directly available in the \`loader\` function's parameters. We've purposefully designed it this way to help you succeed. Let's take a look at why:
- Search Parameters being used in a loader function are a very good indicator that those search params should also be used to uniquely identify the data being loaded. For example, you may have a route that uses a search param like \`pageIndex\` that uniquely identifies the data held inside of the route match. Or, imagine a \`/users/user\` route that uses the search param \`userId\` to identify a specific user in your application, you might model your url like this: \`/users/user?userId=123\`. This means that your \`user\` route would need some extra help to identify a specific user.
- Directly accessing search params in a loader function can lead to bugs in caching and preloading where the data being loaded is not unique to the current URL pathname and search params. For example, you might ask your \`/posts\` route to preload page 2's results, but without the distinction of pages in your route configuration, you will end up fetching, storing and displaying page 2's data on your \`/posts\` or \`?page=1\` screen instead of it preloading in the background!
- Placing a threshold between search parameters and the loader function allows the router to understand your dependencies and reactivity.
\`\`\`tsx
// /routes/users.user.tsx
export const Route = createFileRoute('/users/user')({
validateSearch: (search) =>
search as {
userId: string
},
loaderDeps: ({ search: { userId } }) => ({
userId,
}),
loader: async ({ deps: { userId } }) => getUser(userId),
})
\`\`\`
### Accessing Search Params via \`routeOptions.loaderDeps\`
\`\`\`tsx
// /routes/posts.tsx
export const Route = createFileRoute('/posts')({
// Use zod to validate and parse the search params
validateSearch: z.object({
offset: z.number().int().nonnegative().catch(0),
}),
// Pass the offset to your loader deps via the loaderDeps function
loaderDeps: ({ search: { offset } }) => ({ offset }),
// Use the offset from context in the loader function
loader: async ({ deps: { offset } }) =>
fetchPosts({
offset,
}),
})
\`\`\`
## Using the Abort Signal
The \`abortController\` property of the \`loader\` function is an [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). Its signal is cancelled when the route is unloaded or when the \`loader\` call becomes outdated. This is useful for cancelling network requests when the route is unloaded or when the route's params change. Here is an example using it with a fetch call:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: ({ abortController }) =>
fetchPosts({
// Pass this to an underlying fetch call or anything that supports signals
signal: abortController.signal,
}),
})
\`\`\`
## Using the \`preload\` flag
The \`preload\` property of the \`loader\` function is a boolean which is \`true\` when the route is being preloaded instead of loaded. Some data loading libraries may handle preloading differently than a standard fetch, so you may want to pass \`preload\` to your data loading library, or use it to execute the appropriate data loading logic:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: async ({ preload }) =>
fetchPosts({
maxAge: preload ? 10_000 : 0, // Preloads should hang around a bit longer
}),
})
\`\`\`
## Handling Slow Loaders
Ideally most route loaders can resolve their data within a short moment, removing the need to render a placeholder spinner and simply rely on suspense to render the next route when it's completely ready. When critical data that is required to render a route's component is slow though, you have 2 options:
- Split up your fast and slow data into separate promises and \`defer\` the slow data until after the fast data is loaded (see the [Deferred Data Loading](./deferred-data-loading.md) guide).
- Show a pending component after an optimistic suspense threshold until all of the data is ready (See below).
## Showing a pending component
**By default, TanStack Router will show a pending component for loaders that take longer than 1 second to resolve.** This is an optimistic threshold that can be configured via:
- \`routeOptions.pendingMs\` or
- \`routerOptions.defaultPendingMs\`
When the pending time threshold is exceeded, the router will render the \`pendingComponent\` option of the route, if configured.
## Avoiding Pending Component Flash
If you're using a pending component, the last thing you want is for your pending time threshold to be met, then have your data resolve immediately after, resulting in a jarring flash of your pending component. To avoid this, **TanStack Router by default will show your pending component for at least 500ms**. This is an optimistic threshold that can be configured via:
- \`routeOptions.pendingMinMs\` or
- \`routerOptions.defaultPendingMinMs\`
## Handling Errors
TanStack Router provides a few ways to handle errors that occur during the route loading lifecycle. Let's take a look at them.
### Handling Errors with \`routeOptions.onError\`
The \`routeOptions.onError\` option is a function that is called when an error occurs during the route loading.
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
onError: ({ error }) => {
// Log the error
console.error(error)
},
})
\`\`\`
### Handling Errors with \`routeOptions.onCatch\`
The \`routeOptions.onCatch\` option is a function that is called whenever an error was caught by the router's CatchBoundary.
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
onCatch: ({ error, errorInfo }) => {
// Log the error
console.error(error)
},
})
\`\`\`
### Handling Errors with \`routeOptions.errorComponent\`
The \`routeOptions.errorComponent\` option is a component that is rendered when an error occurs during the route loading or rendering lifecycle. It is rendered with the following props:
- \`error\` - The error that occurred
- \`reset\` - A function to reset the internal \`CatchBoundary\`
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
errorComponent: ({ error }) => {
// Render an error message
return
{error.message}
},
})
\`\`\`
The \`reset\` function can be used to allow the user to retry rendering the error boundaries normal children:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
errorComponent: ({ error, reset }) => {
return (
{error.message}
)
},
})
\`\`\`
If the error was the result of a route load, you should instead call \`router.invalidate()\`, which will coordinate both a router reload and an error boundary reset:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
errorComponent: ({ error, reset }) => {
const router = useRouter()
return (
{error.message}
)
},
})
\`\`\`
### Using the default \`ErrorComponent\`
TanStack Router provides a default \`ErrorComponent\` that is rendered when an error occurs during the route loading or rendering lifecycle. If you choose to override your routes' error components, it's still wise to always fall back to rendering any uncaught errors with the default \`ErrorComponent\`:
\`\`\`tsx
// src/routes/posts.tsx
export const Route = createFileRoute('/posts')({
loader: () => fetchPosts(),
errorComponent: ({ error }) => {
if (error instanceof MyCustomError) {
// Render a custom error message
return
{error.message}
}
// Fallback to the default ErrorComponent
return
},
})
\`\`\`
# Data Mutations
Since TanStack router does not store or cache data, it's role in data mutation is slim to none outside of reacting to potential URL side-effects from external mutation events. That said, we've compiled a list of mutation-related features you might find useful and libraries that implement them.
Look for and use mutation utilities that support:
- Handling and caching submission state
- Providing both local and global optimistic UI support
- Built-in hooks to wire up invalidation (or automatically support it)
- Handling multiple in-flight mutations at once
- Organizing mutation state as a globally accessible resource
- Submission state history and garbage collection
Some suggested libraries:
- [TanStack Query](https://tanstack.com/query/latest/docs/react/guides/mutations)
- [SWR](https://swr.vercel.app/)
- [RTK Query](https://redux-toolkit.js.org/rtk-query/overview)
- [urql](https://formidable.com/open-source/urql/)
- [Relay](https://relay.dev/)
- [Apollo](https://www.apollographql.com/docs/react/)
Or, even...
- [Zustand](https://zustand-demo.pmnd.rs/)
- [Jotai](https://jotai.org/)
- [Recoil](https://recoiljs.org/)
- [Redux](https://redux.js.org/)
Similar to data fetching, mutation state isn't a one-size-fits-all solution, so you'll need to pick a solution that fits your needs and your team's needs. We recommend trying out a few different solutions and seeing what works best for you.
> β οΈ Still here? Submission state is an interesting topic when it comes to persistence. Do you keep every mutation around forever? How do you know when to get rid of it? What if the user navigates away from the screen and then back? Let's dig in!
## Invalidating TanStack Router after a mutation
TanStack Router comes with short-term caching built-in. So even though we're not storing any data after a route match is unmounted, there is a high probability that if any mutations are made related to the data stored in the Router, the current route matches' data could become stale.
When mutations related to loader data are made, we can use \`router.invalidate\` to force the router to reload all of the current route matches:
\`\`\`tsx
const router = useRouter()
const addTodo = async (todo: Todo) => {
try {
await api.addTodo()
router.invalidate()
} catch {
//
}
}
\`\`\`
Invalidating all of the current route matches happens in the background, so existing data will continue to be served until the new data is ready, just as if you were navigating to a new route.
If you want to await the invalidation until all loaders have finished, pass \`{sync: true}\` into \`router.invalidate\`:
\`\`\`tsx
const router = useRouter()
const addTodo = async (todo: Todo) => {
try {
await api.addTodo()
await router.invalidate({ sync: true })
} catch {
//
}
}
\`\`\`
## Long-term mutation State
Regardless of the mutation library used, mutations often create state related to their submission. While most mutations are set-and-forget, some mutation states are more long-lived, either to support optimistic UI or to provide feedback to the user about the status of their submissions. Most state managers will correctly keep this submission state around and expose it to make it possible to show UI elements like loading spinners, success messages, error messages, etc.
Let's consider the following interactions:
- User navigates to the \`/posts/123/edit\` screen to edit a post
- User edits the \`123\` post and upon success, sees a success message below the editor that the post was updated
- User navigates to the \`/posts\` screen
- User navigates back to the \`/posts/123/edit\` screen again
Without notifying your mutation management library about the route change, it's possible that your submission state could still be around and your user would still see the **"Post updated successfully"** message when they return to the previous screen. This is not ideal. Obviously, our intent wasn't to keep this mutation state around forever, right?!
## Using mutation keys
Hopefully and hypothetically, the easiest way is for your mutation library to support a keying mechanism that will allow your mutations's state to be reset when the key changes:
\`\`\`tsx
const routeApi = getRouteApi('/room/$roomId/chat')
function ChatRoom() {
const { roomId } = routeApi.useParams()
const sendMessageMutation = useCoolMutation({
fn: sendMessage,
// Clear the mutation state when the roomId changes
// including any submission state
key: ['sendMessage', roomId],
})
// Fire off a bunch of messages
const test = () => {
sendMessageMutation.mutate({ roomId, message: 'Hello!' })
sendMessageMutation.mutate({ roomId, message: 'How are you?' })
sendMessageMutation.mutate({ roomId, message: 'Goodbye!' })
}
return (
<>
{sendMessageMutation.submissions.map((submission) => {
return (
{submission.status}
{submission.message}
)
})}
)
}
\`\`\`
## Using the \`router.subscribe\` method
See the [Router Events guide](./router-events.md) for a more complete walkthrough of the available events and when to use them.
For libraries that don't have a keying mechanism, we'll likely need to manually reset the mutation state when the user navigates away from the screen. To solve this, we can use TanStack Router's \`invalidate\` and \`subscribe\` method to clear mutation states when the user is no longer in need of them.
The \`router.subscribe\` method is a function that subscribes a callback to various router events. The event in particular that we'll use here is the \`onResolved\` event. It's important to understand that this event is fired when the location path is _changed (not just reloaded) and has finally resolved_.
This is a great place to reset your old mutation states. Here's an example:
\`\`\`tsx
const router = createRouter()
const coolMutationCache = createCoolMutationCache()
const unsubscribeFn = router.subscribe('onResolved', () => {
// Reset mutation states when the route changes
coolMutationCache.clear()
})
\`\`\`
# Deferred Data Loading
TanStack Router is designed to run loaders in parallel and wait for all of them to resolve before rendering the next route. This is great most of the time, but occasionally, you may want to show the user something sooner while the rest of the data loads in the background.
Deferred data loading is a pattern that allows the router to render the next location's critical data/markup while slower, non-critical route data is resolved in the background. This process works on both the client and server (via streaming) and is a great way to improve the perceived performance of your application.
If you are using a library like [TanStack Query](https://tanstack.com/query/latest) or any other data fetching library, then deferred data loading works a bit differently. Skip ahead to the [Deferred Data Loading with External Libraries](#deferred-data-loading-with-external-libraries) section for more information.
## Deferred Data Loading with \`Await\`
To defer slow or non-critical data, return an **unawaited/unresolved** promise anywhere in your loader response:
\`\`\`tsx
// src/routes/posts.$postId.tsx
import { createFileRoute, defer } from '@tanstack/react-router'
export const Route = createFileRoute('/posts/$postId')({
loader: async () => {
// Fetch some slower data, but do not await it
const slowDataPromise = fetchSlowData()
// Fetch and await some data that resolves quickly
const fastData = await fetchFastData()
return {
fastData,
deferredSlowData: slowDataPromise,
}
},
})
\`\`\`
As soon as any awaited promises are resolved, the next route will begin rendering while the deferred promises continue to resolve.
In the component, deferred promises can be resolved and utilized using the \`Await\` component:
\`\`\`tsx
// src/routes/posts.$postId.tsx
import { createFileRoute, Await } from '@tanstack/react-router'
export const Route = createFileRoute('/posts/$postId')({
// ...
component: PostIdComponent,
})
function PostIdComponent() {
const { deferredSlowData, fastData } = Route.useLoaderData()
// do something with fastData
return (
Loading...}>
{(data) => {
return
{data}
}}
)
}
\`\`\`
> [!TIP]
> If your component is code-split, you can use the [getRouteApi function](./code-splitting.md#manually-accessing-route-apis-in-other-files-with-the-getrouteapi-helper) to avoid having to import the \`Route\` configuration to get access to the typed \`useLoaderData()\` hook.
The \`Await\` component resolves the promise by triggering the nearest suspense boundary until it is resolved, after which it renders the component's \`children\` as a function with the resolved data.
If the promise is rejected, the \`Await\` component will throw the serialized error, which can be caught by the nearest error boundary.
# React
> [!TIP]
> In React 19, you can use the \`use()\` hook instead of \`Await\`
## Deferred Data Loading with External libraries
When your strategy for fetching information for the route relies on [External Data Loading](./external-data-loading.md) with an external library like [TanStack Query](https://tanstack.com/query), deferred data loading works a bit differently, as the library handles the data fetching and caching for you outside of TanStack Router.
So, instead of using \`defer\` and \`Await\`, you'll instead want to use the Route's \`loader\` to kick off the data fetching and then use the library's hooks to access the data in your components.
# React
\`\`\`tsx
// src/routes/posts.$postId.tsx
import { createFileRoute } from '@tanstack/react-router'
import { slowDataOptions, fastDataOptions } from '~/api/query-options'
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ context: { queryClient } }) => {
// Kick off the fetching of some slower data, but do not await it
queryClient.prefetchQuery(slowDataOptions())
// Fetch and await some data that resolves quickly
await queryClient.ensureQueryData(fastDataOptions())
},
})
\`\`\`
# Solid
\`\`\`tsx
// src/routes/posts.$postId.tsx
import { createFileRoute } from '@tanstack/solid-router'
import { slowDataOptions, fastDataOptions } from '~/api/query-options'
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ context: { queryClient } }) => {
// Kick off the fetching of some slower data, but do not await it
queryClient.prefetchQuery(slowDataOptions())
// Fetch and await some data that resolves quickly
await queryClient.ensureQueryData(fastDataOptions())
},
})
\`\`\`
Then in your component, you can use the library's hooks to access the data:
# React
\`\`\`tsx
// src/routes/posts.$postId.tsx
import { createFileRoute } from '@tanstack/react-router'
import { useSuspenseQuery } from '@tanstack/react-query'
import { slowDataOptions, fastDataOptions } from '~/api/query-options'
export const Route = createFileRoute('/posts/$postId')({
// ...
component: PostIdComponent,
})
function PostIdComponent() {
const fastData = useSuspenseQuery(fastDataOptions())
// do something with fastData
return (
Loading...}>
)
}
function SlowDataComponent() {
const data = useSuspenseQuery(slowDataOptions())
return
{data}
}
\`\`\`
# Solid
\`\`\`tsx
// src/routes/posts.$postId.tsx
import { createFileRoute } from '@tanstack/solid-router'
import { useSuspenseQuery } from '@tanstack/solid-query'
import { slowDataOptions, fastDataOptions } from '~/api/query-options'
export const Route = createFileRoute('/posts/$postId')({
// ...
component: PostIdComponent,
})
function PostIdComponent() {
const fastData = useSuspenseQuery(fastDataOptions())
// do something with fastData
return (
Loading...}>
)
}
function SlowDataComponent() {
const data = useSuspenseQuery(slowDataOptions())
return
{data()}
}
\`\`\`
## Caching and Invalidation
Streamed promises follow the same lifecycle as the loader data they are associated with. They can even be preloaded!
# React
## SSR & Streaming Deferred Data
**Streaming requires a server that supports it and for TanStack Router to be configured to use it properly.**
Please read the entire [Streaming SSR Guide](./ssr.md#streaming-ssr) for step by step instructions on how to set up your server for streaming.
## SSR Streaming Lifecycle
The following is a high-level overview of how deferred data streaming works with TanStack Router:
- Server
- Promises are marked and tracked as they are returned from route loaders
- All loaders resolve and any deferred promises are serialized and embedded into the html
- The route begins to render
- Deferred promises rendered with the \`\` component trigger suspense boundaries, allowing the server to stream html up to that point
- Client
- The client receives the initial html from the server
- \`\` components suspend with placeholder promises while they wait for their data to resolve on the server
- Server
- As deferred promises resolve, their results (or errors) are serialized and streamed to the client via an inline script tag
- The resolved \`\` components and their suspense boundaries are resolved and their resulting HTML is streamed to the client along with their dehydrated data
- Client
- The suspended placeholder promises within \`\` are resolved with the streamed data/error responses and either render the result or throw the error to the nearest error boundary
# Document Head Management
Document head management is the process of managing the head, title, meta, link, and script tags of a document and TanStack Router provides a robust way to manage the document head for full-stack applications that use Start and for single-page applications that use TanStack Router. It provides:
- Automatic deduping of \`title\` and \`meta\` tags
- Automatic loading/unloading of tags based on route visibility
- A composable way to merge \`title\` and \`meta\` tags from nested routes
For full-stack applications that use Start, and even for single-page applications that use TanStack Router, managing the document head is a crucial part of any application for the following reasons:
- SEO
- Social media sharing
- Analytics
- CSS and JS loading/unloading
To manage the document head, it's required that you render both the \`\` and \`\` components and use the \`routeOptions.head\` property to manage the head of a route, which returns an object with \`title\`, \`meta\`, \`links\`, \`styles\`, and \`scripts\` properties.
## Managing the Document Head
\`\`\`tsx
export const Route = createRootRoute({
head: () => ({
meta: [
{
name: 'description',
content: 'My App is a web application',
},
{
title: 'My App',
},
],
links: [
{
rel: 'icon',
href: '/favicon.ico',
},
],
styles: [
{
media: 'all and (max-width: 500px)',
children: \`p {
color: blue;
background-color: yellow;
}\`,
},
],
scripts: [
{
src: 'https://www.google-analytics.com/analytics.js',
},
],
}),
})
\`\`\`
### Deduping
Out of the box, TanStack Router will dedupe \`title\` and \`meta\` tags, preferring the **last** occurrence of each tag found in nested routes.
- \`title\` tags defined in nested routes will override a \`title\` tag defined in a parent route (but you can compose them together, which is covered in a future section of this guide)
- \`meta\` tags with the same \`name\` or \`property\` will be overridden by the last occurrence of that tag found in nested routes
### \`\`
The \`\` component is **required** to render the head, title, meta, link, and head-related script tags of a document.
It should be **rendered either in the \`\` tag of your root layout or as high up in the component tree as possible** if your application doesn't or can't manage the \`\` tag.
For manifest-managed assets, you can also set \`crossorigin\` values on emitted
\`modulepreload\` and stylesheet links:
\`\`\`tsx
\`\`\`
\`assetCrossOrigin\` only applies to manifest-managed asset links emitted by Start.
If you also set \`crossOrigin\` via \`transformAssets\` (either the object shorthand
or a callback return value), \`assetCrossOrigin\` wins.
### Start/Full-Stack Applications
# React
\`\`\`tsx
import { HeadContent } from '@tanstack/react-router'
export const Route = createRootRoute({
component: () => (
),
})
\`\`\`
# Solid
\`\`\`tsx
import { HeadContent } from '@tanstack/solid-router'
export const Route = createRootRoute({
component: () => (
),
})
\`\`\`
### Single-Page Applications
First, remove the \`\` tag from the index.html if you have set any.
<!-- ::start:framework -->
# React
\`\`\`tsx
import { HeadContent } from '@tanstack/react-router'
const rootRoute = createRootRoute({
component: () => (
<>
<HeadContent />
<Outlet />
</>
),
})
\`\`\`
# Solid
\`\`\`tsx
import { HeadContent } from '@tanstack/solid-router'
const rootRoute = createRootRoute({
component: () => (
<>
<HeadContent />
<Outlet />
</>
),
})
\`\`\`
<!-- ::end:framework -->
## Managing Body Scripts
In addition to scripts that can be rendered in the \`<head>\` tag, you can also render scripts in the \`<body>\` tag using the \`routeOptions.scripts\` property. This is useful for loading scripts (even inline scripts) that require the DOM to be loaded, but before the main entry point of your application (which includes hydration if you're using Start or a full-stack implementation of TanStack Router).
To do this, you must:
- Use the \`scripts\` property of the \`routeOptions\` object
- [Render the \`<Scripts />\` component](#scripts)
\`\`\`tsx
export const Route = createRootRoute({
scripts: () => [
{
children: 'console.log("Hello, world!")',
},
],
})
\`\`\`
### \`<Scripts />\`
The \`<Scripts />\` component is **required** to render the body scripts of a document. It should be rendered either in the \`<body>\` tag of your root layout or as high up in the component tree as possible if your application doesn't or can't manage the \`<body>\` tag.
### Example
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRootRoute, Scripts } from '@tanstack/react-router'
export const Route = createFileRoute('/')({
component: () => (
<html>
<head />
<body>
<Outlet />
<Scripts />
</body>
</html>
),
})
\`\`\`
# Solid
\`\`\`tsx
import { createFileRoute, Scripts } from '@tanstack/solid-router'
export const Route = createRootRoute('/')({
component: () => (
<html>
<head />
<body>
<Outlet />
<Scripts />
</body>
</html>
),
})
\`\`\`
<!-- ::end:framework -->
## Inline Scripts with ScriptOnce
For scripts that must run before React hydrates (like theme detection), use \`ScriptOnce\`. This is particularly useful for avoiding flash of unstyled content (FOUC) or theme flicker.
<!-- ::start:framework -->
# React
\`\`\`tsx
import { ScriptOnce } from '@tanstack/react-router'
const themeScript = \`(function() {
try {
const theme = localStorage.getItem('theme') || 'auto';
const resolved = theme === 'auto'
? (matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light')
: theme;
document.documentElement.classList.add(resolved);
} catch (e) {}
})();\`
function ThemeProvider({ children }) {
return (
<>
<ScriptOnce children={themeScript} />
{children}
</>
)
}
\`\`\`
# Solid
\`\`\`tsx
import { ScriptOnce } from '@tanstack/solid-router'
const themeScript = \`(function() {
try {
const theme = localStorage.getItem('theme') || 'auto';
const resolved = theme === 'auto'
? (matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light')
: theme;
document.documentElement.classList.add(resolved);
} catch (e) {}
})();\`
function ThemeProvider({ children }) {
return (
<>
<ScriptOnce children={themeScript} />
{children}
</>
)
}
\`\`\`
<!-- ::end:framework -->
### How ScriptOnce Works
1. During SSR, renders a \`<script>\` tag with the provided code
2. The script executes immediately when the browser parses the HTML (before React hydrates)
3. After execution, the script removes itself from the DOM
4. On client-side navigation, nothing is rendered (prevents duplicate execution)
<!-- ::start:framework -->
# React
### Preventing Hydration Warnings
If your script modifies the DOM before hydration (like adding a class to \`<html>\`), use \`suppressHydrationWarning\` to prevent React warnings:
\`\`\`tsx
export const Route = createRootRoute({
component: () => (
<html lang="en" suppressHydrationWarning>
<head>
<HeadContent />
</head>
<body>
<ThemeProvider>
<Outlet />
</ThemeProvider>
<Scripts />
</body>
</html>
),
})
\`\`\`
<!-- ::end:framework -->
### Common Use Cases
- **Theme/dark mode detection** - Apply theme class before hydration to prevent flash
- **Feature detection** - Check browser capabilities before rendering
- **Analytics initialization** - Initialize tracking before user interaction
- **Critical path setup** - Any JavaScript that must run before hydration
# External Data Loading
> [!IMPORTANT]
> This guide is geared towards external state management libraries and their integration with TanStack Router for data fetching, ssr, hydration/dehydration and streaming. If you haven't read the standard [Data Loading](./data-loading.md) guide, please do so first.
## To **Store** or to **Coordinate**?
While Router is very capable of storing and managing most data needs out of the box, sometimes you just might want something more robust!
Router is designed to be a perfect **coordinator** for external data fetching and caching libraries. This means that you can use any data fetching/caching library you want, and the router will coordinate the loading of your data in a way that aligns with your users' navigation and expectations of freshness.
## What data fetching libraries are supported?
Any data fetching library that supports asynchronous promises can be used with TanStack Router. This includes:
- [TanStack Query](https://tanstack.com/query/latest/docs/react/overview)
- [SWR](https://swr.vercel.app/)
- [RTK Query](https://redux-toolkit.js.org/rtk-query/overview)
- [urql](https://formidable.com/open-source/urql/)
- [Relay](https://relay.dev/)
- [Apollo](https://www.apollographql.com/docs/react/)
Or, even...
- [Zustand](https://zustand-demo.pmnd.rs/)
- [Jotai](https://jotai.org/)
- [Recoil](https://recoiljs.org/)
- [Redux](https://redux.js.org/)
Literally any library that **can return a promise and read/write data** can be integrated.
## Using Loaders to ensure data is loaded
The easiest way to integrate external caching/data library into Router is to use \`route.loader\`s to ensure that the data required inside of a route has been loaded and is ready to be displayed.
> β οΈ BUT WHY? It's very important to preload your critical render data in the loader for a few reasons:
>
> - No "flash of loading" states
> - No waterfall data fetching, caused by component based fetching
> - Better for SEO. If your data is available at render time, it will be indexed by search engines.
Here is a naive illustration (don't do this) of using a Route's \`loader\` option to seed the cache for some data:
\`\`\`tsx
// src/routes/posts.tsx
let postsCache = []
export const Route = createFileRoute('/posts')({
loader: async () => {
postsCache = await fetchPosts()
},
component: () => {
return (
<div>
{postsCache.map((post) => (
<Post key={post.id} post={post} />
))}
</div>
)
},
})
\`\`\`
This example is **obviously flawed**, but illustrates the point that you can use a route's \`loader\` option to seed your cache with data. Let's take a look at a more realistic example using TanStack Query.
- Replace \`fetchPosts\` with your preferred data fetching library's prefetching API
- Replace \`postsCache\` with your preferred data fetching library's read-or-fetch API or hook
## A more realistic example using TanStack Query
Let's take a look at a more realistic example using TanStack Query.
\`\`\`tsx
// src/routes/posts.tsx
const postsQueryOptions = queryOptions({
queryKey: ['posts'],
queryFn: () => fetchPosts(),
})
export const Route = createFileRoute('/posts')({
// Use the \`loader\` option to ensure that the data is loaded
loader: () => queryClient.ensureQueryData(postsQueryOptions),
component: () => {
// Read the data from the cache and subscribe to updates
const {
data: { posts },
} = useSuspenseQuery(postsQueryOptions)
return (
<div>
{posts.map((post) => (
<Post key={post.id} post={post} />
))}
</div>
)
},
})
\`\`\`
### Error handling with TanStack Query
When an error occurs while using \`suspense\` with \`TanStack Query\`, you need to let queries know that you want to try again when re-rendering. This can be done by using the \`reset\` function provided by the \`useQueryErrorResetBoundary\` hook. You can invoke this function in an effect as soon as the error component mounts. This will make sure that the query is reset and will try to fetch data again when the route component is rendered again. This will also cover cases where users navigate away from the route instead of clicking the \`retry\` button.
\`\`\`tsx
export const Route = createFileRoute('/')({
loader: () => queryClient.ensureQueryData(postsQueryOptions),
errorComponent: ({ error, reset }) => {
const router = useRouter()
const queryErrorResetBoundary = useQueryErrorResetBoundary()
useEffect(() => {
// Reset the query error boundary
queryErrorResetBoundary.reset()
}, [queryErrorResetBoundary])
return (
<div>
{error.message}
<button
onClick={() => {
// Invalidate the route to reload the loader, and reset any router error boundaries
router.invalidate()
}}
>
retry
</button>
</div>
)
},
})
\`\`\`
## SSR Dehydration/Hydration
Tools that are able can integrate with TanStack Router's convenient Dehydration/Hydration APIs to shuttle dehydrated data between the server and client and rehydrate it where needed. Let's go over how to do this with both 3rd party critical data and 3rd party deferred data.
## Critical Dehydration/Hydration
**For critical data needed for the first render/paint**, TanStack Router supports **\`dehydrate\` and \`hydrate\`** options when configuring the \`Router\`. These callbacks are functions that are automatically called on the server and client when the router dehydrates and hydrates normally and allow you to augment the dehydrated data with your own data.
The \`dehydrate\` function can return any serializable JSON data which will get merged and injected into the dehydrated payload that is sent to the client.
For example, let's dehydrate and hydrate a TanStack Query \`QueryClient\` so that our data we fetched on the server will be available for hydration on the client.
\`\`\`tsx
// src/router.tsx
export function createRouter() {
// Make sure you create your loader client or similar data
// stores inside of your \`createRouter\` function. This ensures
// that your data stores are unique to each request and
// always present on both server and client.
const queryClient = new QueryClient()
return createRouter({
routeTree,
// Optionally provide your loaderClient to the router context for
// convenience (you can provide anything you want to the router
// context!)
context: {
queryClient,
},
// On the server, dehydrate the loader client so the router
// can serialize it and send it to the client for us
dehydrate: () => {
return {
queryClientState: dehydrate(queryClient),
}
},
// On the client, hydrate the loader client with the data
// we dehydrated on the server
hydrate: (dehydrated) => {
hydrate(queryClient, dehydrated.queryClientState)
},
// Optionally, we can use \`Wrap\` to wrap our router in the loader client provider
Wrap: ({ children }) => {
return (
<QueryClientProvider client={queryClient}>
{children}
</QueryClientProvider>
)
},
})
}
\`\`\`
# History Types
While it's not required to know the \`@tanstack/history\` API itself to use TanStack Router, it's a good idea to understand how it works. Under the hood, TanStack Router requires and uses a \`history\` abstraction to manage the routing history.
If you don't create a history instance, a browser-oriented instance of this API is created for you when the router is initialized. If you need a special history API type, You can use the \`@tanstack/history\` package to create your own:
- \`createBrowserHistory\`: The default history type.
- \`createHashHistory\`: A history type that uses a hash to track history.
- \`createMemoryHistory\`: A history type that keeps the history in memory.
Once you have a history instance, you can pass it to the \`Router\` constructor:
<!-- ::start:framework -->
# React
\`\`\`ts
import { createMemoryHistory, createRouter } from '@tanstack/react-router'
const memoryHistory = createMemoryHistory({
initialEntries: ['/'], // Pass your initial url
})
const router = createRouter({ routeTree, history: memoryHistory })
\`\`\`
# Solid
\`\`\`ts
import { createMemoryHistory, createRouter } from '@tanstack/solid-router'
const memoryHistory = createMemoryHistory({
initialEntries: ['/'], // Pass your initial url
})
const router = createRouter({ routeTree, history: memoryHistory })
\`\`\`
<!-- ::end:framework -->
## Browser Routing
The \`createBrowserHistory\` is the default history type. It uses the browser's history API to manage the browser history.
## Hash Routing
Hash routing can be helpful if your server doesn't support rewrites to index.html for HTTP requests (among other environments that don't have a server).
<!-- ::start:framework -->
# React
\`\`\`ts
import { createHashHistory, createRouter } from '@tanstack/react-router'
const hashHistory = createHashHistory()
const router = createRouter({ routeTree, history: hashHistory })
\`\`\`
# Solid
\`\`\`ts
import { createHashHistory, createRouter } from '@tanstack/solid-router'
const hashHistory = createHashHistory()
const router = createRouter({ routeTree, history: hashHistory })
\`\`\`
<!-- ::end:framework -->
## Memory Routing
Memory routing is useful in environments that are not a browser or when you do not want components to interact with the URL.
<!-- ::start:framework -->
# React
\`\`\`ts
import { createMemoryHistory, createRouter } from '@tanstack/react-router'
const memoryHistory = createMemoryHistory({
initialEntries: ['/'], // Pass your initial url
})
const router = createRouter({ routeTree, history: memoryHistory })
\`\`\`
# Solid
\`\`\`ts
import { createMemoryHistory, createRouter } from '@tanstack/solid-router'
const memoryHistory = createMemoryHistory({
initialEntries: ['/'], // Pass your initial url
})
const router = createRouter({ routeTree, history: memoryHistory })
\`\`\`
<!-- ::end:framework -->
Refer to the [SSR Guide](./ssr.md#automatic-server-history) for usage on the server for server-side rendering.
# Internationalization (i18n)
TanStack Router provides flexible and highly customizable primitives that can be composed to support common internationalization (i18n) routing patterns, such as **optional path parameters**, **route rewriting**, and **type-safe params**. This enables clean, SEO-friendly URLs, flexible locale handling, and seamless integration with i18n libraries.
This guide covers:
- Prefix-based and optional-locale routing
- Advanced routing patterns for i18n
- Language navigation and switching
- SEO considerations
- Type safety
- Integration patterns with i18n libraries (Paraglide)
---
## i18n with Optional Path Parameters
This pattern relies exclusively on TanStack Router features. It is suitable when:
- You want full control over translations
- You already manage translations manually
- You do not need automatic locale detection
Optional path parameters are ideal for implementing locale-aware routing without duplicating routes.
\`\`\`
/{-$locale}/about
\`\`\`
This single route matches:
- \`/about\` (default locale)
- \`/en/about\`
- \`/fr/about\`
- \`/es/about\`
### Prefix-based i18n
\`\`\`tsx
// Route: /{-$locale}/about
export const Route = createFileRoute('/{-$locale}/about')({
component: AboutComponent,
})
function AboutComponent() {
const { locale } = Route.useParams()
const currentLocale = locale || 'en'
const content = {
en: { title: 'About Us' },
fr: { title: 'Γ Propos' },
es: { title: 'Acerca de' },
}
return <h1>{content[currentLocale].title}</h1>
}
\`\`\`
### Complex Routing Patterns
\`\`\`tsx
// Route: /{-$locale}/blog/{-$category}/$slug
export const Route = createFileRoute('/{-$locale}/blog/{-$category}/$slug')({
beforeLoad: ({ params }) => {
const locale = params.locale || 'en'
const validLocales = ['en', 'fr', 'es', 'de']
if (params.locale && !validLocales.includes(params.locale)) {
throw new Error('Invalid locale')
}
return { locale }
},
})
\`\`\`
### Language Switching
\`\`\`tsx
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={(prev) => ({
...prev,
locale: prev.locale === 'en' ? undefined : 'fr',
})}
>
Français
</Link>
\`\`\`
### Type-safe Locales
\`\`\`ts
type Locale = 'en' | 'fr' | 'es' | 'de'
function isLocale(value?: string): value is Locale {
return ['en', 'fr', 'es', 'de'].includes(value as Locale)
}
\`\`\`
---
## i18n Library Integration Patterns
TanStack Router is **library-agnostic**. You can integrate any i18n solution by mapping locale state to routing behavior.
Below is a recommended pattern using **Paraglide**.
---
## Client-side i18n with a Library (TanStack Router)
This pattern combines TanStack Router with a client-side i18n library. It is suitable when:
- You want type-safe translations
- You want localized URLs
- You do not need server-side rendering
### TanStack Router + Paraglide (Client-only)
Paraglide provides type-safe translations, locale detection, and URL localization that pair naturally with TanStack Router.
**GitHub example:**
[https://github.com/TanStack/router/tree/main/examples/react/i18n-paraglide](https://github.com/TanStack/router/tree/main/examples/react/i18n-paraglide)
### Project Setup
\`\`\`bash
npx @inlang/paraglide-js@latest init
\`\`\`
\`\`\`ts
import { paraglideVitePlugin } from '@inlang/paraglide-js'
paraglideVitePlugin({
project: './project.inlang',
outdir: './app/paraglide',
})
\`\`\`
### URL Localization via Router Rewrite
The router's \`rewrite\` option enables bidirectional URL transformation, perfect for locale prefixes. For comprehensive documentation on URL rewrites including advanced patterns, see the [URL Rewrites guide](./url-rewrites.md).
\`\`\`ts
import { deLocalizeUrl, localizeUrl } from './paraglide/runtime'
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => deLocalizeUrl(url),
output: ({ url }) => localizeUrl(url),
},
})
\`\`\`
---
## Server-side i18n (TanStack Start)
This pattern integrates i18n at the routing and server layers. It is suitable when:
- You use TanStack Start
- You need SSR or streaming
- You want locale-aware redirects and metadata
### TanStack Start + Paraglide
**GitHub example:**
[https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide](https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide)
### Server Middleware (SSR)
\`\`\`ts
import { paraglideMiddleware } from './paraglide/server'
export default {
fetch(req: Request) {
return paraglideMiddleware(req, () => handler.fetch(req))
},
}
\`\`\`
### HTML Language Attribute
\`\`\`tsx
import { getLocale } from '../paraglide/runtime'
;<html lang={getLocale()} />
\`\`\`
---
## Offline-safe Redirects
For offline or client-only environments:
\`\`\`ts
import { shouldRedirect } from '../paraglide/runtime'
beforeLoad: async () => {
const decision = await shouldRedirect({ url: window.location.href })
if (decision.redirectUrl) {
throw redirect({ href: decision.redirectUrl.href })
}
}
\`\`\`
---
## Type-safe Translated Pathnames
To ensure every route has translations, you can derive translated pathnames directly from the TanStack Router route tree.
\`\`\`ts
import { FileRoutesByTo } from '../routeTree.gen'
import { Locale } from '@/paraglide/runtime'
\`\`\`
This guarantees:
- No missing translations
- Full type safety
- Compiler feedback for routing mistakes
---
## Prerendering Localized Routes
\`\`\`ts
import { localizeHref } from './paraglide/runtime'
export const prerenderRoutes = ['/', '/about'].map((path) => ({
path: localizeHref(path),
prerender: { enabled: true },
}))
\`\`\`
---
## Additional i18n Integration Patterns
### Intlayer (TanStack Start integration)
[https://intlayer.org/doc/environment/tanstack-start](https://intlayer.org/doc/environment/tanstack-start)
### use-intl (TanStack Start integration)
[https://nikuscs.com/blog/13-tanstackstart-i18n/](https://nikuscs.com/blog/13-tanstackstart-i18n/)
# Link Options
You may want to reuse options that are intended to be passed to \`Link\`, \`redirect\` or \`navigate\`. In which case you may decide an object literal is a good way to represent options passed to \`Link\`.
\`\`\`tsx
const dashboardLinkOptions = {
to: '/dashboard',
search: { search: '' },
}
function DashboardComponent() {
return <Link {...dashboardLinkOptions} />
}
\`\`\`
There are a few problems here. \`dashboardLinkOptions.to\` is inferred as \`string\` which by default will resolve to every route when passed to \`Link\`, \`navigate\` or \`redirect\` (this particular issue could be fixed by \`as const\`). The other issue here is we do not know \`dashboardLinkOptions\` even passes the type checker until it is spread into \`Link\`. We could very easily create incorrect navigation options and only when the options are spread into \`Link\` do we know there is a type error.
### Using \`linkOptions\` function to create re-usable options
\`linkOptions\` is a function which type checks an object literal and returns the inferred input as is. This provides type safety on options exactly like \`Link\` before it is used allowing for easier maintenance and re-usability. Our above example using \`linkOptions\` looks like this:
\`\`\`tsx
const dashboardLinkOptions = linkOptions({
to: '/dashboard',
search: { search: '' },
})
function DashboardComponent() {
return <Link {...dashboardLinkOptions} />
}
\`\`\`
This allows eager type checking of \`dashboardLinkOptions\` which can then be re-used anywhere
\`\`\`tsx
const dashboardLinkOptions = linkOptions({
to: '/dashboard',
search: { search: '' },
})
export const Route = createFileRoute('/dashboard')({
component: DashboardComponent,
validateSearch: (input) => ({ search: input.search }),
beforeLoad: () => {
// can used in redirect
throw redirect(dashboardLinkOptions)
},
})
function DashboardComponent() {
const navigate = useNavigate()
return (
<div>
{/** can be used in navigate */}
<button onClick={() => navigate(dashboardLinkOptions)} />
{/** can be used in Link */}
<Link {...dashboardLinkOptions} />
</div>
)
}
\`\`\`
### An array of \`linkOptions\`
When creating navigation you might loop over an array to construct a navigation bar. In which case \`linkOptions\` can be used to type check an array of object literals which are intended for \`Link\` props
\`\`\`tsx
const options = linkOptions([
{
to: '/dashboard',
label: 'Summary',
activeOptions: { exact: true },
},
{
to: '/dashboard/invoices',
label: 'Invoices',
},
{
to: '/dashboard/users',
label: 'Users',
},
])
function DashboardComponent() {
return (
<>
<div className="flex items-center border-b">
<h2 className="text-xl p-2">Dashboard</h2>
</div>
<div className="flex flex-wrap divide-x">
{options.map((option) => {
return (
<Link
{...option}
key={option.to}
activeProps={{ className: \`font-bold\` }}
className="p-2"
>
{option.label}
</Link>
)
})}
</div>
<hr />
<Outlet />
</>
)
}
\`\`\`
The input of \`linkOptions\` is inferred and returned, as shown with the use of \`label\` as this does not exist on \`Link\` props
# Navigation Blocking
Navigation blocking is a way to prevent navigation from happening. This is typical if a user attempts to navigate while they:
- Have unsaved changes
- Are in the middle of a form
- Are in the middle of a payment
In these situations, a prompt or custom UI should be shown to the user to confirm they want to navigate away.
- If the user confirms, navigation will continue as normal
- If the user cancels, all pending navigations will be blocked
## How does navigation blocking work?
Navigation blocking adds one or more layers of "blockers" to the entire underlying history API. If any blockers are present, navigation will be paused via one of the following ways:
- Custom UI
- If the navigation is triggered by something we control at the router level, we can allow you to perform any task or show any UI you'd like to the user to confirm the action. Each blocker's \`blocker\` function will be asynchronously and sequentially executed. If any blocker function resolves or returns \`true\`, the navigation will be allowed and all other blockers will continue to do the same until all blockers have been allowed to proceed. If any single blocker resolves or returns \`false\`, the navigation will be canceled and the rest of the \`blocker\` functions will be ignored.
- The \`onbeforeunload\` event
- For page events that we cannot control directly, we rely on the browser's \`onbeforeunload\` event. If the user attempts to close the tab or window, refresh, or "unload" the page assets in any way, the browser's generic "Are you sure you want to leave?" dialog will be shown. If the user confirms, all blockers will be bypassed and the page will unload. If the user cancels, the unload will be cancelled, and the page will remain as is.
## How do I use navigation blocking?
There are 2 ways to use navigation blocking:
- Hook/logical-based blocking
- Component-based blocking
## Hook/logical-based blocking
Let's imagine we want to prevent navigation if a form is dirty. We can do this by using the \`useBlocker\` hook:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { useBlocker } from '@tanstack/react-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
useBlocker({
shouldBlockFn: () => {
if (!formIsDirty) return false
const shouldLeave = confirm('Are you sure you want to leave?')
return !shouldLeave
},
})
// ...
}
\`\`\`
# Solid
\`\`\`tsx
import { useBlocker } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = createSignal(false)
useBlocker({
shouldBlockFn: () => {
if (!formIsDirty()) return false
const shouldLeave = confirm('Are you sure you want to leave?')
return !shouldLeave
},
})
// ...
}
\`\`\`
<!-- ::end:framework -->
\`shouldBlockFn\` gives you type safe access to the \`current\` and \`next\` location:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { useBlocker } from '@tanstack/react-router'
function MyComponent() {
// always block going from /foo to /bar/123?hello=world
const { proceed, reset, status } = useBlocker({
shouldBlockFn: ({ current, next }) => {
return (
current.routeId === '/foo' &&
next.fullPath === '/bar/$id' &&
next.params.id === 123 &&
next.search.hello === 'world'
)
},
withResolver: true,
})
// ...
}
\`\`\`
# Solid
\`\`\`tsx
import { useBlocker } from '@tanstack/solid-router'
function MyComponent() {
// always block going from /foo to /bar/123?hello=world
const { proceed, reset, status } = useBlocker({
shouldBlockFn: ({ current, next }) => {
return (
current.routeId === '/foo' &&
next.fullPath === '/bar/$id' &&
next.params.id === 123 &&
next.search.hello === 'world'
)
},
withResolver: true,
})
// ...
}
\`\`\`
<!-- ::end:framework -->
Note that even if \`shouldBlockFn\` returns \`false\`, the browser's \`beforeunload\` event may still be triggered on page reloads or tab closing. To gain control over this, you can use the \`enableBeforeUnload\` option to conditionally register the \`beforeunload\` handler:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { useBlocker } from '@tanstack/react-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
useBlocker({
{/* ... */}
enableBeforeUnload: formIsDirty, // or () => formIsDirty
})
// ...
}
\`\`\`
# Solid
\`\`\`tsx
import { useBlocker } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
useBlocker({
{/* ... */}
enableBeforeUnload: formIsDirty(),
})
// ...
}
\`\`\`
<!-- ::end:framework -->
You can find more information about the \`useBlocker\` hook in the [API reference](../api/router/useBlockerHook.md).
## Component-based blocking
In addition to logical/hook based blocking, you can use the \`Block\` component to achieve similar results:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { Block } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
return (
<Block
shouldBlockFn={() => {
if (!formIsDirty) return false
const shouldLeave = confirm('Are you sure you want to leave?')
return !shouldLeave
}}
enableBeforeUnload={formIsDirty}
/>
)
// OR
return (
<Block
shouldBlockFn={() => formIsDirty}
enableBeforeUnload={formIsDirty}
withResolver
>
{({ status, proceed, reset }) => <>{/* ... */}</>}
</Block>
)
}
\`\`\`
# Solid
\`\`\`tsx
import { Block } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = createSignal(false)
return (
<Block
shouldBlockFn={() => {
if (!formIsDirty()) return false
const shouldLeave = confirm('Are you sure you want to leave?')
return !shouldLeave
}}
/>
)
// OR
return (
<Block shouldBlockFn={() => !formIsDirty} withResolver>
{({ status, proceed, reset }) => <>{/* ... */}</>}
</Block>
)
}
\`\`\`
<!-- ::end:framework -->
## How can I show a custom UI?
In most cases, using \`window.confirm\` in the \`shouldBlockFn\` function with \`withResolver: false\` in the hook is enough since it will clearly show the user that the navigation is being blocked and resolve the blocking based on their response.
However, in some situations, you might want to show a custom UI that is intentionally less disruptive and more integrated with your app's design.
**Note:** The return value of \`shouldBlockFn\` does not resolve the blocking if \`withResolver\` is \`true\`.
### Hook/logical-based custom UI with resolver
<!-- ::start:framework -->
# React
\`\`\`tsx
import { useBlocker } from '@tanstack/react-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
const { proceed, reset, status } = useBlocker({
shouldBlockFn: () => formIsDirty,
withResolver: true,
})
// ...
return (
<>
{/* ... */}
{status === 'blocked' && (
<div>
<p>Are you sure you want to leave?</p>
<button onClick={proceed}>Yes</button>
<button onClick={reset}>No</button>
</div>
)}
</>
}
\`\`\`
# Solid
\`\`\`tsx
import { useBlocker } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = createSignal(false)
const { proceed, reset, status } = useBlocker({
shouldBlockFn: () => formIsDirty(),
withResolver: true,
})
// ...
return (
<>
{/* ... */}
{status === 'blocked' && (
<div>
<p>Are you sure you want to leave?</p>
<button onClick={proceed}>Yes</button>
<button onClick={reset}>No</button>
</div>
)}
</>
}
\`\`\`
<!-- ::end:framework -->
### Hook/logical-based custom UI without resolver
<!-- ::start:framework -->
# React
\`\`\`tsx
import { useBlocker } from '@tanstack/react-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
useBlocker({
shouldBlockFn: () => {
if (!formIsDirty) {
return false
}
const shouldBlock = new Promise<boolean>((resolve) => {
// Using a modal manager of your choice
modals.open({
title: 'Are you sure you want to leave?',
children: (
<SaveBlocker
confirm={() => {
modals.closeAll()
resolve(false)
}}
reject={() => {
modals.closeAll()
resolve(true)
}}
/>
),
onClose: () => resolve(true),
})
})
return shouldBlock
},
})
// ...
}
\`\`\`
# Solid
\`\`\`tsx
import { useBlocker } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = createSignal(false)
useBlocker({
shouldBlockFn: () => {
if (!formIsDirty()) {
return false
}
const shouldBlock = new Promise<boolean>((resolve) => {
// Using a modal manager of your choice
modals.open({
title: 'Are you sure you want to leave?',
children: (
<SaveBlocker
confirm={() => {
modals.closeAll()
resolve(false)
}}
reject={() => {
modals.closeAll()
resolve(true)
}}
/>
),
onClose: () => resolve(true),
})
})
return shouldBlock
},
})
// ...
}
\`\`\`
<!-- ::end:framework -->
### Component-based custom UI
Similarly to the hook, the \`Block\` component returns the same state and functions as render props:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { Block } from '@tanstack/react-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = useState(false)
return (
<Block shouldBlockFn={() => formIsDirty} withResolver>
{({ status, proceed, reset }) => (
<>
{/* ... */}
{status === 'blocked' && (
<div>
<p>Are you sure you want to leave?</p>
<button onClick={proceed}>Yes</button>
<button onClick={reset}>No</button>
</div>
)}
</>
)}
</Block>
)
}
\`\`\`
# Solid
\`\`\`tsx
import { Block } from '@tanstack/solid-router'
function MyComponent() {
const [formIsDirty, setFormIsDirty] = createSignal(false)
return (
<Block shouldBlockFn={() => formIsDirty()} withResolver>
{({ status, proceed, reset }) => (
<>
{/* ... */}
{status === 'blocked' && (
<div>
<p>Are you sure you want to leave?</p>
<button onClick={proceed}>Yes</button>
<button onClick={reset}>No</button>
</div>
)}
</>
)}
</Block>
)
}
\`\`\`
<!-- ::end:framework -->
# Navigation
## Everything is Relative
Believe it or not, every navigation within an app is **relative**, even if you aren't using explicit relative path syntax (\`../../somewhere\`). Any time a link is clicked or an imperative navigation call is made, you will always have an **origin** path and a **destination** path which means you are navigating **from** one route **to** another route.
TanStack Router keeps this constant concept of relative navigation in mind for every navigation, so you'll constantly see two properties in the API:
- \`from\` - The origin route path
- \`to\` - The destination route path
> β οΈ If a \`from\` route path isn't provided the router will assume you are navigating from the root \`/\` route and only auto-complete absolute paths. After all, you need to know where you are from in order to know where you're going π.
## Shared Navigation API
Every navigation and route matching API in TanStack Router uses the same core interface with minor differences depending on the API. This means that you can learn navigation and route matching once and use the same syntax and concepts across the library.
### \`ToOptions\` Interface
This is the core \`ToOptions\` interface that is used in every navigation and route matching API:
\`\`\`ts
type ToOptions<
TRouteTree extends AnyRoute = AnyRoute,
TFrom extends RoutePaths<TRouteTree> | string = string,
TTo extends string = '',
> = {
// \`from\` is an optional route ID or path. If it is not supplied, only absolute paths will be auto-completed and type-safe. It's common to supply the route.fullPath of the origin route you are rendering from for convenience. If you don't know the origin route, leave this empty and work with absolute paths or unsafe relative paths.
from?: string
// \`to\` can be an absolute route path or a relative path from the \`from\` option to a valid route path. β οΈ Do not interpolate path params, hash or search params into the \`to\` options. Use the \`params\`, \`search\`, and \`hash\` options instead.
to: string
// \`params\` is either an object of path params to interpolate into the \`to\` option or a function that supplies the previous params and allows you to return new ones. This is the only way to interpolate dynamic parameters into the final URL. Depending on the \`from\` and \`to\` route, you may need to supply none, some or all of the path params. TypeScript will notify you of the required params if there are any.
params:
| Record<string, unknown>
| ((prevParams: Record<string, unknown>) => Record<string, unknown>)
// \`search\` is either an object of query params or a function that supplies the previous search and allows you to return new ones. Depending on the \`from\` and \`to\` route, you may need to supply none, some or all of the query params. TypeScript will notify you of the required search params if there are any.
search:
| Record<string, unknown>
| ((prevSearch: Record<string, unknown>) => Record<string, unknown>)
// \`hash\` is either a string or a function that supplies the previous hash and allows you to return a new one.
hash?: string | ((prevHash: string) => string)
// \`state\` is either an object of state or a function that supplies the previous state and allows you to return a new one. State is stored in the history API and can be useful for passing data between routes that you do not want to permanently store in URL search params.
state?:
| Record<string, any>
| ((prevState: Record<string, unknown>) => Record<string, unknown>)
// \`mask\` is another navigation object used to mask the URL shown in the browser for this navigation.
mask?: ToMaskOptions<TRouteTree>
}
type ToMaskOptions<TRouteTree extends AnyRoute = AnyRoute> = {
// \`from\`, \`to\`, \`params\`, \`search\`, \`hash\`, and \`state\` behave the same as in \`ToOptions\`.
// \`mask\` itself is not allowed inside \`ToMaskOptions\`.
from?: string
to: string
params:
| Record<string, unknown>
| ((prevParams: Record<string, unknown>) => Record<string, unknown>)
search:
| Record<string, unknown>
| ((prevSearch: Record<string, unknown>) => Record<string, unknown>)
hash?: string | ((prevHash: string) => string)
state?:
| Record<string, any>
| ((prevState: Record<string, unknown>) => Record<string, unknown>)
// If true, the URL will unmask on page reload.
unmaskOnReload?: boolean
}
\`\`\`
> π§ Every route object has a \`to\` property, which can be used as the \`to\` for any navigation or route matching API. Where possible, this will allow you to avoid plain strings and use type-safe route references instead:
\`\`\`tsx
import { Route as aboutRoute } from './routes/about.tsx'
function Comp() {
return <Link to={aboutRoute.to}>About</Link>
}
\`\`\`
### \`NavigateOptions\` Interface
This is the core \`NavigateOptions\` interface that extends \`ToOptions\`. Any API that is actually performing a navigation will use this interface:
\`\`\`ts
export type NavigateOptions<
TRouteTree extends AnyRoute = AnyRoute,
TFrom extends RoutePaths<TRouteTree> | string = string,
TTo extends string = '',
> = ToOptions<TRouteTree, TFrom, TTo> & {
// \`replace\` is a boolean that determines whether the navigation should replace the current history entry or push a new one.
replace?: boolean
// \`resetScroll\` is a boolean that determines whether scroll position will be reset to 0,0 after the location is committed to browser history.
resetScroll?: boolean
// \`hashScrollIntoView\` is a boolean or object that determines whether an id matching the hash will be scrolled into view after the location is committed to history.
hashScrollIntoView?: boolean | ScrollIntoViewOptions
// \`viewTransition\` is either a boolean or function that determines if and how the browser will call document.startViewTransition() when navigating.
viewTransition?: boolean | ViewTransitionOptions
// \`ignoreBlocker\` is a boolean that determines if navigation should ignore any blockers that might prevent it.
ignoreBlocker?: boolean
// \`reloadDocument\` is a boolean that determines if navigation to a route inside of router will trigger a full page load instead of the traditional SPA navigation.
reloadDocument?: boolean
// \`href\` is a string that can be used in place of \`to\` to navigate to a full built href, e.g. pointing to an external target.
href?: string
}
\`\`\`
\`NavigateOptions\` includes all \`ToOptions\` fields, including \`mask\`.
### \`LinkOptions\` Interface
Anywhere an actual \`<a>\` tag the \`LinkOptions\` interface which extends \`NavigateOptions\` will be available:
\`\`\`tsx
export type LinkOptions<
TRouteTree extends AnyRoute = AnyRoute,
TFrom extends RoutePaths<TRouteTree> | string = string,
TTo extends string = '',
> = NavigateOptions<TRouteTree, TFrom, TTo> & {
// The standard anchor tag target attribute
target?: HTMLAnchorElement['target']
// Defaults to \`{ exact: false, includeHash: false }\`
activeOptions?: {
exact?: boolean
includeHash?: boolean
includeSearch?: boolean
explicitUndefined?: boolean
}
// If set, will preload the linked route on hover and cache it for this many milliseconds in hopes that the user will eventually navigate there.
preload?: false | 'intent'
// Delay intent preloading by this many milliseconds. If the intent exits before this delay, the preload will be cancelled.
preloadDelay?: number
// If true, will render the link without the href attribute
disabled?: boolean
}
\`\`\`
Since \`LinkOptions\` extends \`NavigateOptions\`, it also supports \`mask\`.
## Navigation API
With relative navigation and all of the interfaces in mind now, let's talk about the different flavors of navigation API at your disposal:
- The \`<Link>\` component
- Generates an actual \`<a>\` tag with a valid \`href\` which can be click or even cmd/ctrl + clicked to open in a new tab
- The \`useNavigate()\` hook
- When possible, \`Link\` component should be used for navigation, but sometimes you need to navigate imperatively as a result of a side-effect. \`useNavigate\` returns a function that can be called to perform an immediate client-side navigation.
- The \`<Navigate>\` component
- Renders nothing and performs an immediate client-side navigation.
- The \`Router.navigate()\` method
- This is the most powerful navigation API in TanStack Router. Similar to \`useNavigate\`, it imperatively navigates, but is available everywhere you have access to your router.
β οΈ None of these APIs are a replacement for server-side redirects. If you need to redirect a user immediately from one route to another before mounting your application, use a server-side redirect instead of a client-side navigation.
## \`<Link>\` Component
The \`Link\` component is the most common way to navigate within an app. It renders an actual \`<a>\` tag with a valid \`href\` attribute which can be clicked or even cmd/ctrl + clicked to open in a new tab. It also supports any normal \`<a>\` attributes including \`target\` to open links in new windows, etc.
In addition to the [\`LinkOptions\`](#linkoptions-interface) interface, the \`Link\` component also supports the following props:
\`\`\`tsx
export type LinkProps<
TFrom extends RoutePaths<RegisteredRouter['routeTree']> | string = string,
TTo extends string = '',
> = LinkOptions<RegisteredRouter['routeTree'], TFrom, TTo> & {
// A function that returns additional props for the \`active\` state of this link. These props override other props passed to the link (\`style\`'s are merged, \`className\`'s are concatenated)
activeProps?:
| FrameworkHTMLAnchorTagAttributes
| (() => FrameworkHTMLAnchorAttributes)
// A function that returns additional props for the \`inactive\` state of this link. These props override other props passed to the link (\`style\`'s are merged, \`className\`'s are concatenated)
inactiveProps?:
| FrameworkHTMLAnchorAttributes
| (() => FrameworkHTMLAnchorAttributes)
}
\`\`\`
### Absolute Links
Let's make a simple static link!
<!-- ::start:framework -->
# React
\`\`\`tsx
import { Link } from '@tanstack/react-router'
const link = <Link to="/about">About</Link>
\`\`\`
# Solid
\`\`\`tsx
import { Link } from '@tanstack/solid-router'
const link = <Link to="/about">About</Link>
\`\`\`
<!-- ::end:framework -->
### Dynamic Links
Dynamic links are links that have dynamic segments in them. For example, a link to a blog post might look like this:
\`\`\`tsx
const link = (
<Link
to="/blog/post/$postId"
params={{
postId: 'my-first-blog-post',
}}
>
Blog Post
</Link>
)
\`\`\`
Keep in mind that normally dynamic segment params are \`string\` values, but they can also be any other type that you parse them to in your route options. Either way, the type will be checked at compile time to ensure that you are passing the correct type.
### Relative Links
By default, all links are absolute unless a \`from\` route path is provided. This means that the above link will always navigate to the \`/about\` route regardless of what route you are currently on.
Relative links can be combined with a \`from\` route path. If a from route path isn't provided, relative paths default to the current active location.
> [!NOTE]
> Keep in mind that when calling useNavigate as a method on the route, for example \`Route.useNavigate\`, then the \`from\` location is predefined to be the route it's called on.
>
> Another common pitfall is when using this in a pathless layout route, since the pathless layout route does not have an actual path, the \`from\` location is regarded as the parent of the pathless layout route. Hence relative routing will be resolved from this parent.
\`\`\`tsx
const postIdRoute = createRoute({
path: '/blog/post/$postId',
})
const link = (
<Link from={postIdRoute.fullPath} to="../categories">
Categories
</Link>
)
\`\`\`
As seen above, it's common to provide the \`route.fullPath\` as the \`from\` route path. This is because the \`route.fullPath\` is a reference that will update if you refactor your application. However, sometimes it's not possible to import the route directly, in which case it's fine to provide the route path directly as a string. It will still get type-checked as per usual!
### Special relative paths: \`"."\` and \`".."\`
Quite often you might want to reload the current location or another \`from\` path, for example, to rerun the loaders on the current and/or parent routes, or maybe navigate back to a parent route. This can be achieved by specifying a \`to\` route path of \`"."\` which will reload the current location or provided \`from\` path.
Another common need is to navigate one route back relative to the current location or another path. By specifying a \`to\` route path of \`".."\` navigation will be resolved to the first parent route preceding the current location.
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId')({
component: PostComponent,
})
function PostComponent() {
return (
<div>
<Link to=".">Reload the current route of /posts/$postId</Link>
<Link to="..">Navigate back to /posts</Link>
// the below are all equivalent
<Link to="/posts">Navigate back to /posts</Link>
<Link from="/posts" to=".">
Navigate back to /posts
</Link>
// the below are all equivalent
<Link to="/">Navigate to root</Link>
<Link from="/posts" to="..">
Navigate to root
</Link>
</div>
)
}
\`\`\`
### Search Param Links
Search params are a great way to provide additional context to a route. For example, you might want to provide a search query to a search page:
\`\`\`tsx
const link = (
<Link
to="/search"
search={{
query: 'tanstack',
}}
>
Search
</Link>
)
\`\`\`
It's also common to want to update a single search param without supplying any other information about the existing route. For example, you might want to update the page number of a search result:
\`\`\`tsx
const link = (
<Link
to="."
search={(prev) => ({
...prev,
page: prev.page + 1,
})}
>
Next Page
</Link>
)
\`\`\`
### Search Param Type Safety
Search params are a highly dynamic state management mechanism, so it's important to ensure that you are passing the correct types to your search params. We'll see in a later section in detail how to validate and ensure search params typesafety, among other great features!
### Hash Links
Hash links are a great way to link to a specific section of a page. For example, you might want to link to a specific section of a blog post:
\`\`\`tsx
const link = (
<Link
to="/blog/post/$postId"
params={{
postId: 'my-first-blog-post',
}}
hash="section-1"
>
Section 1
</Link>
)
\`\`\`
> β οΈ When directly navigating to a URL with a hash fragment, the fragment is only available on the client; the browser does not send the fragment to the server as part of the request URL.
>
> This means that if you are using a server-side rendering approach, the hash fragment will not be available on the server-side, and hydration mismatches can occur when using the hash for rendering markup.
>
> Examples of this would be:
>
> - returning the hash value in the markup,
> - conditional rendering based on the hash value, or
> - setting the Link as active based on the hash value.
### Navigating with Optional Parameters
Optional path parameters provide flexible navigation patterns where you can include or omit parameters as needed. Optional parameters use the \`{-$paramName}\` syntax and offer fine-grained control over URL structure.
#### Parameter Inheritance vs Removal
When navigating with optional parameters, you have two main strategies:
**Inheriting Current Parameters**
Use \`params: {}\` to inherit all current route parameters:
\`\`\`tsx
// Inherits current route parameters
<Link to="/posts/{-$category}" params={{}}>
All Posts
</Link>
\`\`\`
**Removing Parameters**
Set parameters to \`undefined\` to explicitly remove them:
\`\`\`tsx
// Removes the category parameter
<Link to="/posts/{-$category}" params={{ category: undefined }}>
All Posts
</Link>
\`\`\`
#### Basic Optional Parameter Navigation
\`\`\`tsx
// Navigate with optional parameter
<Link
to="/posts/{-$category}"
params={{ category: 'tech' }}
>
Tech Posts
</Link>
// Navigate without optional parameter
<Link
to="/posts/{-$category}"
params={{ category: undefined }}
>
All Posts
</Link>
// Navigate using parameter inheritance
<Link
to="/posts/{-$category}"
params={{}}
>
Current Category
</Link>
\`\`\`
#### Function-Style Parameter Updates
Function-style parameter updates are particularly useful with optional parameters:
\`\`\`tsx
// Remove a parameter using function syntax
<Link
to="/posts/{-$category}"
params={(prev) => ({ ...prev, category: undefined })}
>
Clear Category
</Link>
// Update a parameter while keeping others
<Link
to="/articles/{-$category}/{-$slug}"
params={(prev) => ({ ...prev, category: 'news' })}
>
News Articles
</Link>
// Conditionally set parameters
<Link
to="/posts/{-$category}"
params={(prev) => ({
...prev,
category: someCondition ? 'tech' : undefined
})}
>
Conditional Category
</Link>
\`\`\`
#### Multiple Optional Parameters
When working with multiple optional parameters, you can mix and match which ones to include:
\`\`\`tsx
// Navigate with some optional parameters
<Link
to="/posts/{-$category}/{-$slug}"
params={{ category: 'tech', slug: undefined }}
>
Tech Posts
</Link>
// Remove all optional parameters
<Link
to="/posts/{-$category}/{-$slug}"
params={{ category: undefined, slug: undefined }}
>
All Posts
</Link>
// Set multiple parameters
<Link
to="/posts/{-$category}/{-$slug}"
params={{ category: 'tech', slug: 'react-tips' }}
>
Specific Post
</Link>
\`\`\`
#### Mixed Required and Optional Parameters
Optional parameters work seamlessly with required parameters:
\`\`\`tsx
// Required 'id', optional 'tab'
<Link
to="/users/$id/{-$tab}"
params={{ id: '123', tab: 'settings' }}
>
User Settings
</Link>
// Remove optional parameter while keeping required
<Link
to="/users/$id/{-$tab}"
params={{ id: '123', tab: undefined }}
>
User Profile
</Link>
// Use function style with mixed parameters
<Link
to="/users/$id/{-$tab}"
params={(prev) => ({ ...prev, tab: 'notifications' })}
>
User Notifications
</Link>
\`\`\`
#### Advanced Optional Parameter Patterns
**Prefix and Suffix Parameters**
Optional parameters with prefix/suffix work with navigation:
\`\`\`tsx
// Navigate to file with optional name
<Link
to="/files/prefix{-$name}.txt"
params={{ name: 'document' }}
>
Document File
</Link>
// Navigate to file without optional name
<Link
to="/files/prefix{-$name}.txt"
params={{ name: undefined }}
>
Default File
</Link>
\`\`\`
**All Optional Parameters**
Routes where all parameters are optional:
\`\`\`tsx
// Navigate to specific date
<Link
to="/{-$year}/{-$month}/{-$day}"
params={{ year: '2023', month: '12', day: '25' }}
>
Christmas 2023
</Link>
// Navigate to partial date
<Link
to="/{-$year}/{-$month}/{-$day}"
params={{ year: '2023', month: '12', day: undefined }}
>
December 2023
</Link>
// Navigate to root with all parameters removed
<Link
to="/{-$year}/{-$month}/{-$day}"
params={{ year: undefined, month: undefined, day: undefined }}
>
Home
</Link>
\`\`\`
#### Navigation with Search Params and Optional Parameters
Optional parameters work great in combination with search params:
\`\`\`tsx
// Combine optional path params with search params
<Link
to="/posts/{-$category}"
params={{ category: 'tech' }}
search={{ page: 1, sort: 'newest' }}
>
Tech Posts - Page 1
</Link>
// Remove path param but keep search params
<Link
to="/posts/{-$category}"
params={{ category: undefined }}
search={(prev) => prev}
>
All Posts - Same Filters
</Link>
\`\`\`
#### Imperative Navigation with Optional Parameters
All the same patterns work with imperative navigation:
\`\`\`tsx
function Component() {
const navigate = useNavigate()
const clearFilters = () => {
navigate({
to: '/posts/{-$category}/{-$tag}',
params: { category: undefined, tag: undefined },
})
}
const setCategory = (category: string) => {
navigate({
to: '/posts/{-$category}/{-$tag}',
params: (prev) => ({ ...prev, category }),
})
}
const applyFilters = (category?: string, tag?: string) => {
navigate({
to: '/posts/{-$category}/{-$tag}',
params: { category, tag },
})
}
}
\`\`\`
### Active & Inactive Props
The \`Link\` component supports two additional props: \`activeProps\` and \`inactiveProps\`. These props are functions that return additional props for the \`active\` and \`inactive\` states of the link. All props other than styles and classes passed here will override the original props passed to \`Link\`. Any styles or classes passed are merged together.
Here's an example:
\`\`\`tsx
const link = (
<Link
to="/blog/post/$postId"
params={{
postId: 'my-first-blog-post',
}}
activeProps={{
style: {
fontWeight: 'bold',
},
}}
>
Section 1
</Link>
)
\`\`\`
### The \`data-status\` attribute
In addition to the \`activeProps\` and \`inactiveProps\` props, the \`Link\` component also adds a \`data-status\` attribute to the rendered element when it is in an active state. This attribute will be \`active\` or \`undefined\` depending on the current state of the link. This can come in handy if you prefer to use data-attributes to style your links instead of props.
### Active Options
The \`Link\` component comes with an \`activeOptions\` property that offers a few options of determining if a link is active or not. The following interface describes those options:
\`\`\`tsx
export interface ActiveOptions {
// If true, the link will be active if the current route matches the \`to\` route path exactly (no children routes)
// Defaults to \`false\`
exact?: boolean
// If true, the link will only be active if the current URL hash matches the \`hash\` prop
// Defaults to \`false\`
includeHash?: boolean // Defaults to false
// If true, the link will only be active if the current URL search params inclusively match the \`search\` prop
// Defaults to \`true\`
includeSearch?: boolean
// This modifies the \`includeSearch\` behavior.
// If true, properties in \`search\` that are explicitly \`undefined\` must NOT be present in the current URL search params for the link to be active.
// defaults to \`false\`
explicitUndefined?: boolean
}
\`\`\`
By default, it will check if the resulting **pathname** is a prefix of the current route. If any search params are provided, it will check that they _inclusively_ match those in the current location. Hashes are not checked by default.
For example, if you are on the \`/blog/post/my-first-blog-post\` route, the following links will be active:
\`\`\`tsx
const link1 = (
<Link to="/blog/post/$postId" params={{ postId: 'my-first-blog-post' }}>
Blog Post
</Link>
)
const link2 = <Link to="/blog/post">Blog Post</Link>
const link3 = <Link to="/blog">Blog Post</Link>
\`\`\`
However, the following links will not be active:
\`\`\`tsx
const link4 = (
<Link to="/blog/post/$postId" params={{ postId: 'my-second-blog-post' }}>
Blog Post
</Link>
)
\`\`\`
It's common for some links to only be active if they are an exact match. A good example of this would be a link to the home page. In scenarios like these, you can pass the \`exact: true\` option:
\`\`\`tsx
const link = (
<Link to="/" activeOptions={{ exact: true }}>
Home
</Link>
)
\`\`\`
This will ensure that the link is not active when you are a child route.
A few more options to be aware of:
- If you want to include the hash in your matching, you can pass the \`includeHash: true\` option
- If you do **not** want to include the search params in your matching, you can pass the \`includeSearch: false\` option
### Passing \`isActive\` to children
The \`Link\` component accepts a function for its children, allowing you to propagate its \`isActive\` property to children. For example, you could style a child component based on whether the parent link is active:
\`\`\`tsx
const link = (
<Link to="/blog/post">
{({ isActive }) => {
return (
<>
<span>My Blog Post</span>
<icon className={isActive ? 'active' : 'inactive'} />
</>
)
}}
</Link>
)
\`\`\`
### Link Preloading
The \`Link\` component supports automatically preloading routes on intent (hovering or touchstart for now). This can be configured as a default in the router options (which we'll talk more about soon) or by passing a \`preload='intent'\` prop to the \`Link\` component. Here's an example:
\`\`\`tsx
const link = (
<Link to="/blog/post/$postId" preload="intent">
Blog Post
</Link>
)
\`\`\`
With preloading enabled and relatively quick asynchronous route dependencies (if any), this simple trick can increase the perceived performance of your application with very little effort.
What's even better is that by using a cache-first library like \`@tanstack/query\`, preloaded routes will stick around and be ready for a stale-while-revalidate experience if the user decides to navigate to the route later on.
### Link Preloading Delay
Along with preloading is a configurable delay which determines how long a user must hover over a link to trigger the intent-based preloading. The default delay is 50 milliseconds, but you can change this by passing a \`preloadDelay\` prop to the \`Link\` component with the number of milliseconds you'd like to wait:
\`\`\`tsx
const link = (
<Link to="/blog/post/$postId" preload="intent" preloadDelay={100}>
Blog Post
</Link>
)
\`\`\`
## \`useNavigate\`
> β οΈ Because of the \`Link\` component's built-in affordances around \`href\`, cmd/ctrl + click-ability, and active/inactive capabilities, it's recommended to use the \`Link\` component instead of \`useNavigate\` for anything the user can interact with (e.g. links, buttons). However, there are some cases where \`useNavigate\` is necessary to handle side-effect navigations (e.g. a successful async action that results in a navigation).
The \`useNavigate\` hook returns a \`navigate\` function that can be called to imperatively navigate. It's a great way to navigate to a route from a side-effect (e.g. a successful async action). Here's an example:
\`\`\`tsx
function Component() {
const navigate = useNavigate({ from: '/posts/$postId' })
const handleSubmit = async (e: FrameworkFormEvent) => {
e.preventDefault()
const response = await fetch('/posts', {
method: 'POST',
body: JSON.stringify({ title: 'My First Post' }),
})
const { id: postId } = await response.json()
if (response.ok) {
navigate({ to: '/posts/$postId', params: { postId } })
}
}
}
\`\`\`
> π§ As shown above, you can pass the \`from\` option to specify the route to navigate from in the hook call. While this is also possible to pass in the resulting \`navigate\` function each time you call it, it's recommended to pass it here to reduce on potential error and also not type as much!
### \`navigate\` Options
The \`navigate\` function returned by \`useNavigate\` accepts the [\`NavigateOptions\` interface](#navigateoptions-interface)
## \`Navigate\` Component
Occasionally, you may find yourself needing to navigate immediately when a component mounts. Your first instinct might be to reach for \`useNavigate\` and an immediate side-effect (e.g. useEffect), but this is unnecessary. Instead, you can render the \`Navigate\` component to achieve the same result:
\`\`\`tsx
function Component() {
return <Navigate to="/posts/$postId" params={{ postId: 'my-first-post' }} />
}
\`\`\`
Think of the \`Navigate\` component as a way to navigate to a route immediately when a component mounts. It's a great way to handle client-only redirects. It is _definitely not_ a substitute for handling server-aware redirects responsibly on the server.
## \`router.navigate\`
The \`router.navigate\` method is the same as the \`navigate\` function returned by \`useNavigate\` and accepts the same [\`NavigateOptions\` interface](#navigateoptions-interface). Unlike the \`useNavigate\` hook, it is available anywhere your \`router\` instance is available and is thus a great way to navigate imperatively from anywhere in your application, including outside of your framework.
## \`useMatchRoute\` and \`<MatchRoute>\`
The \`useMatchRoute\` hook and \`<MatchRoute>\` component are the same thing, but the hook is a bit more flexible. They both accept the standard navigation \`ToOptions\` interface either as options or props and return \`true/false\` if that route is currently matched. It also has a handy \`pending\` option that will return \`true\` if the route is currently pending (e.g. a route is currently transitioning to that route). This can be extremely useful for showing optimistic UI around where a user is navigating:
\`\`\`tsx
function Component() {
return (
<div>
<Link to="/users">
Users
<MatchRoute to="/users" pending>
<Spinner />
</MatchRoute>
</Link>
</div>
)
}
\`\`\`
The component version \`<MatchRoute>\` can also be used with a function as children to render something when the route is matched:
\`\`\`tsx
function Component() {
return (
<div>
<Link to="/users">
Users
<MatchRoute to="/users" pending>
{(match) => {
return <Spinner show={match} />
}}
</MatchRoute>
</Link>
</div>
)
}
\`\`\`
The hook version \`useMatchRoute\` returns a function that can be called programmatically to check if a route is matched:
\`\`\`tsx
function Component() {
const matchRoute = useMatchRoute()
useEffect(() => {
if (matchRoute({ to: '/users', pending: true })) {
console.info('The /users route is matched and pending')
}
})
return (
<div>
<Link to="/users">Users</Link>
</div>
)
}
\`\`\`
---
Phew! That's a lot of navigating! That said, hopefully you're feeling pretty good about getting around your application now. Let's move on!
# Not Found Errors
> β οΈ This page covers the newer \`notFound\` function and \`notFoundComponent\` API for handling not found errors. The \`NotFoundRoute\` route is deprecated and will be removed in a future release. See [Migrating from \`NotFoundRoute\`](#migrating-from-notfoundroute) for more information.
## Overview
There are 2 uses for not-found errors in TanStack Router:
- **Non-matching route paths**: When a path does not match any known route matching pattern **OR** when it partially matches a route, but with extra path segments
- The **router** will automatically throw a not-found error when a path does not match any known route matching pattern
- If the router's \`notFoundMode\` is set to \`fuzzy\`, the nearest matching route with a \`notFoundComponent\` will handle the error. If the router's \`notFoundMode\` is set to \`root\`, the root route will handle the error.
- Examples:
- Attempting to access \`/users\` when there is no \`/users\` route
- Attempting to access \`/posts/1/edit\` when the route tree only handles \`/posts/$postId\`
- **Missing resources**: When a resource cannot be found, such as a post with a given ID or any asynchronous data that is not available or does not exist
- **You, the developer** must throw a not-found error when a resource cannot be found. This can be done in the \`beforeLoad\` or \`loader\` functions using the \`notFound\` utility.
- Will be handled by the nearest matching route with a \`notFoundComponent\` (when \`notFound\` is called within \`loader\`) or the root route.
- Examples:
- Attempting to access \`/posts/1\` when the post with ID 1 does not exist
- Attempting to access \`/docs/path/to/document\` when the document does not exist
Under the hood, both of these cases are implemented using the same \`notFound\` function and \`notFoundComponent\` API.
## The \`notFoundMode\` option
When TanStack Router encounters a **pathname** that doesn't match any known route pattern **OR** partially matches a route pattern but with extra trailing pathname segments, it will automatically throw a not-found error.
Depending on the \`notFoundMode\` option, the router will handle these automatic errors differently::
- ["fuzzy" mode](#notfoundmode-fuzzy) (default): The router will intelligently find the closest matching suitable route and display the \`notFoundComponent\`.
- ["root" mode](#notfoundmode-root): All not-found errors will be handled by the root route's \`notFoundComponent\`, regardless of the nearest matching route.
### \`notFoundMode: 'fuzzy'\`
By default, the router's \`notFoundMode\` is set to \`fuzzy\`, which indicates that if a pathname doesn't match any known route, the router will attempt to use the closest matching route with a configured \`notFoundComponent\`.
> **β Why is this the default?** Fuzzy matching to preserve as much parent layout as possible for the user gives them more context to navigate to a useful location based on where they thought they would arrive.
The nearest suitable route is found using the following criteria:
- The route must have a \`notFoundComponent\` configured or the router must have a \`defaultNotFoundComponent\` configured
For example, consider the following route tree:
- \`__root__\` (has a \`notFoundComponent\` configured)
- \`posts\` (has a \`notFoundComponent\` configured)
- \`$postId\` (has a \`notFoundComponent\` configured)
If provided the path of \`/posts/1/edit\`, the following component structure will be rendered:
- \`<Root>\`
- \`<Posts>\`
- \`<Post>\`
- \`<Post.notFoundComponent>\`
The \`notFoundComponent\` of the \`$postId\` route will be rendered because it is the **nearest matching route with a \`notFoundComponent\` configured**.
### \`notFoundMode: 'root'\`
When \`notFoundMode\` is set to \`root\`, all not-found errors will be handled by the root route's \`notFoundComponent\` instead of bubbling up from the nearest fuzzy-matched route.
For example, consider the following route tree:
- \`__root__\` (has a \`notFoundComponent\` configured)
- \`posts\` (has a \`notFoundComponent\` configured)
- \`$postId\` (has a \`notFoundComponent\` configured)
If provided the path of \`/posts/1/edit\`, the following component structure will be rendered:
- \`<Root>\`
- \`<Root.notFoundComponent>\`
The \`notFoundComponent\` of the \`__root__\` route will be rendered because the \`notFoundMode\` is set to \`root\`.
## Configuring a route's \`notFoundComponent\`
To handle both types of not-found errors, you can attach a \`notFoundComponent\` to a route. This component will be rendered when a not-found error is thrown.
For example, configuring a \`notFoundComponent\` for a \`/settings\` route to handle non-existing settings pages:
\`\`\`tsx
export const Route = createFileRoute('/settings')({
component: () => {
return (
<div>
<p>Settings page</p>
<Outlet />
</div>
)
},
notFoundComponent: () => {
return <p>This setting page doesn't exist!</p>
},
})
\`\`\`
Or configuring a \`notFoundComponent\` for a \`/posts/$postId\` route to handle posts that don't exist:
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params: { postId } }) => {
const post = await getPost(postId)
if (!post) throw notFound()
return { post }
},
component: ({ post }) => {
return (
<div>
<h1>{post.title}</h1>
<p>{post.body}</p>
</div>
)
},
notFoundComponent: () => {
return <p>Post not found!</p>
},
})
\`\`\`
## Default Router-Wide Not Found Handling
You may want to provide a default not-found component for every route in your app with child routes.
> Why only routes with children? **Leaf-node routes (routes without children) will never render an \`Outlet\` and therefore are not able to handle not-found errors.**
To do this, pass a \`defaultNotFoundComponent\` to the \`createRouter\` function:
\`\`\`tsx
const router = createRouter({
defaultNotFoundComponent: () => {
return (
<div>
<p>Not found!</p>
<Link to="/">Go home</Link>
</div>
)
},
})
\`\`\`
## Throwing your own \`notFound\` errors
You can manually throw not-found errors in loader methods and components using the \`notFound\` function. This is useful when you need to signal that a resource cannot be found.
The \`notFound\` function works in a similar fashion to the \`redirect\` function. To cause a not-found error, you can **throw a \`notFound()\`**.
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params: { postId } }) => {
// Returns \`null\` if the post doesn't exist
const post = await getPost(postId)
if (!post) {
throw notFound()
// Alternatively, you can make the notFound function throw:
// notFound({ throw: true })
}
// Post is guaranteed to be defined here because we threw an error
return { post }
},
})
\`\`\`
The not-found error above will be handled by the same route or nearest parent route that has either a \`notFoundComponent\` route option or the \`defaultNotFoundComponent\` router option configured.
If neither the route nor any suitable parent route is found to handle the error, the root route will handle it using TanStack Router's **extremely basic (and purposefully undesirable)** default not-found component that simply renders \`<p>Not Found</p>\`. It's highly recommended to either attach at least one \`notFoundComponent\` to the root route or configure a router-wide \`defaultNotFoundComponent\` to handle not-found errors.
> β οΈ When you throw \`notFound()\` in \`beforeLoad\`, TanStack Router resolves it the same way as other not-found errors:
>
> - If you pass \`routeId\`, that route (or the nearest valid ancestor boundary) handles it.
> - If you don't pass \`routeId\`, the nearest route/ancestor with a \`notFoundComponent\` handles it (based on the router's mode and matching rules).
> - If no suitable boundary is found, handling falls back to the root/default not-found behavior.
>
> For \`beforeLoad\`-thrown not-found errors, TanStack Router still runs required parent loaders so the selected not-found boundary can render with the loader data it depends on.
## Specifying Which Routes Handle Not Found Errors
Sometimes you may want to trigger a not-found on a specific parent route and bypass the normal not-found component propagation. To do this, pass in a route id to the \`route\` option in the \`notFound\` function.
\`\`\`tsx
// _pathlessLayout.tsx
export const Route = createFileRoute('/_pathlessLayout')({
// This will render
notFoundComponent: () => {
return <p>Not found (in _pathlessLayout)</p>
},
component: () => {
return (
<div>
<p>This is a pathless layout route!</p>
<Outlet />
</div>
)
},
})
// _pathlessLayout/route-a.tsx
export const Route = createFileRoute('/_pathless/route-a')({
loader: async () => {
// This will make LayoutRoute handle the not-found error
throw notFound({ routeId: '/_pathlessLayout' })
// ^^^^^^^^^ This will autocomplete from the registered router
},
// This WILL NOT render
notFoundComponent: () => {
return <p>Not found (in _pathlessLayout/route-a)</p>
},
})
\`\`\`
### Manually targeting the root route
You can also target the root route by passing the exported \`rootRouteId\` variable to the \`notFound\` function's \`route\` property:
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params: { postId } }) => {
const post = await getPost(postId)
if (!post) throw notFound({ routeId: rootRouteId })
return { post }
},
})
\`\`\`
### Throwing Not Found Errors in Components
You can also throw not-found errors in components. However, **it is recommended to throw not-found errors in loader methods instead of components in order to correctly type loader data and prevent flickering.**
TanStack Router exposes a \`CatchNotFound\` component similar to \`CatchBoundary\` that can be used to catch not-found errors in components and display UI accordingly.
### Data Loading Inside \`notFoundComponent\`
\`notFoundComponent\` is a special case when it comes to data loading. **\`SomeRoute.useLoaderData\` may not be defined depending on which route you are trying to access and where the not-found error gets thrown**. However, \`Route.useParams\`, \`Route.useSearch\`, \`Route.useRouteContext\`, etc. will return a defined value.
**If you need to pass incomplete loader data to \`notFoundComponent\`,** pass the data via the \`data\` option in the \`notFound\` function and validate it in \`notFoundComponent\`.
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params: { postId } }) => {
const post = await getPost(postId)
if (!post)
throw notFound({
// Forward some data to the notFoundComponent
// data: someIncompleteLoaderData
})
return { post }
},
// \`data: unknown\` is passed to the component via the \`data\` option when calling \`notFound\`
notFoundComponent: ({ data }) => {
// β useLoaderData is not valid here: const { post } = Route.useLoaderData()
// β :
const { postId } = Route.useParams()
const search = Route.useSearch()
const context = Route.useRouteContext()
return <p>Post with id {postId} not found!</p>
},
})
\`\`\`
## Usage With SSR
See [SSR guide](./ssr.md) for more information.
## Migrating from \`NotFoundRoute\`
The \`NotFoundRoute\` API is deprecated in favor of \`notFoundComponent\`. The \`NotFoundRoute\` API will be removed in a future release.
**The \`notFound\` function and \`notFoundComponent\` will not work when using \`NotFoundRoute\`.**
The main differences are:
- \`NotFoundRoute\` is a route that requires an \`<Outlet>\` on its parent route to render. \`notFoundComponent\` is a component that can be attached to any route.
- When using \`NotFoundRoute\`, you can't use layouts. \`notFoundComponent\` can be used with layouts.
- When using \`notFoundComponent\`, path matching is strict. This means that if you have a route at \`/post/$postId\`, a not-found error will be thrown if you try to access \`/post/1/2/3\`. With \`NotFoundRoute\`, \`/post/1/2/3\` would match the \`NotFoundRoute\` and only render it if there is an \`<Outlet>\`.
To migrate from \`NotFoundRoute\` to \`notFoundComponent\`, you'll just need to make a few changes:
\`\`\`tsx title='src/router.tsx'
import { createRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen.'
- import { notFoundRoute } from './notFoundRoute' // [!code --]
export const router = createRouter({
routeTree,
- notFoundRoute // [!code --]
})
// routes/__root.tsx
import { createRootRoute } from '@tanstack/react-router'
export const Route = createRootRoute({
// ...
+ notFoundComponent: () => { // [!code ++]
+ return <p>Not found!</p> // [!code ++]
+ } // [!code ++]
})
\`\`\`
Important changes:
- A \`notFoundComponent\` is added to the root route for global not-found handling.
- You can also add a \`notFoundComponent\` to any other route in your route tree to handle not-found errors for that specific route.
- The \`notFoundComponent\` does not support rendering an \`<Outlet>\`.
# Outlets
Nested routing means that routes can be nested within other routes, including the way they render. So how do we tell our routes where to render this nested content?
## The \`Outlet\` Component
The \`Outlet\` component is used to render the next potentially matching child route. \`<Outlet />\` doesn't take any props and can be rendered anywhere within a route's component tree. If there is no matching child route, \`<Outlet />\` will render \`null\`.
> [!TIP]
> If a route's \`component\` is left undefined, it will render an \`<Outlet />\` automatically.
A great example is configuring the root route of your application. Let's give our root route a component that renders a title, then an \`<Outlet />\` for our top-level routes to render.
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRootRoute, Outlet } from '@tanstack/react-router'
export const Route = createRootRoute({
component: RootComponent,
})
function RootComponent() {
return (
<div>
<h1>My App</h1>
<Outlet /> {/* This is where child routes will render */}
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx
import { createRootRoute, Outlet } from '@tanstack/solid-router'
export const Route = createRootRoute({
component: RootComponent,
})
function RootComponent() {
return (
<div>
<h1>My App</h1>
<Outlet /> {/* This is where child routes will render */}
</div>
)
}
\`\`\`
<!-- ::end:framework -->
# Parallel Routes
We haven't covered this yet. Stay tuned!
# Path Params
Path params are used to match a single segment (the text until the next \`/\`) and provide its value back to you as a **named** variable. They are defined by using the \`$\` character prefix in the path, followed by the key variable to assign it to. The following are valid path param paths:
- \`$postId\`
- \`$name\`
- \`$teamId\`
- \`about/$name\`
- \`team/$teamId\`
- \`blog/$postId\`
Because path param routes only match to the next \`/\`, child routes can be created to continue expressing hierarchy:
Let's create a post route file that uses a path param to match the post ID:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/posts.$postId.tsx"
import { createFileRoute } from '@tanstack/react-router'
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params }) => {
return fetchPost(params.postId)
},
})
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.$postId.tsx"
import { createFileRoute } from '@tanstack/solid-router'
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params }) => {
return fetchPost(params.postId)
},
})
\`\`\`
<!-- ::end:framework -->
## Path Params can be used by child routes
Once a path param has been parsed, it is available to all child routes. This means that if we define a child route to our \`postRoute\`, we can use the \`postId\` variable from the URL in the child route's path!
## Path Params in Loaders
Path params are passed to the loader as a \`params\` object. The keys of this object are the names of the path params, and the values are the values that were parsed out of the actual URL path. For example, if we were to visit the \`/blog/123\` URL, the \`params\` object would be \`{ postId: '123' }\`:
\`\`\`tsx title="src/routes/posts.$postId.tsx"
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params }) => {
return fetchPost(params.postId)
},
})
\`\`\`
The \`params\` object is also passed to the \`beforeLoad\` option:
\`\`\`tsx title="src/routes/posts.$postId.tsx"
export const Route = createFileRoute('/posts/$postId')({
beforeLoad: async ({ params }) => {
// do something with params.postId
},
})
\`\`\`
## Path Params in Components
If we add a component to our \`postRoute\`, we can access the \`postId\` variable from the URL by using the route's \`useParams\` hook:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/posts.$postId.tsx"
export const Route = createFileRoute('/posts/$postId')({
component: PostComponent,
})
function PostComponent() {
const { postId } = Route.useParams()
return <div>Post {postId}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts.$postId.tsx"
export const Route = createFileRoute('/posts/$postId')({
component: PostComponent,
})
function PostComponent() {
const params = Route.useParams()
return <div>Post {params().postId}</div>
}
\`\`\`
<!-- ::end:framework -->
> π§ Quick tip: If your component is code-split, you can use the [getRouteApi function](./code-splitting.md#manually-accessing-route-apis-in-other-files-with-the-getrouteapi-helper) to avoid having to import the \`Route\` configuration to get access to the typed \`useParams()\` hook.
## Path Params outside of Routes
You can also use the globally exported \`useParams\` hook to access any parsed path params from any component in your app. You'll need to pass the \`strict: false\` option to \`useParams\`, denoting that you want to access the params from an ambiguous location:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/components/PostComponent.tsx"
function PostComponent() {
const { postId } = useParams({ strict: false })
return <div>Post {postId}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/components/PostComponent.tsx"
function PostComponent() {
const params = useParams({ strict: false })
return <div>Post {params().postId}</div>
}
\`\`\`
<!-- ::end:framework -->
## Navigating with Path Params
When navigating to a route with path params, TypeScript will require you to pass the params either as an object or as a function that returns an object of params.
Let's see what an object style looks like:
\`\`\`tsx
function Component() {
return (
<Link to="/blog/$postId" params={{ postId: '123' }}>
Post 123
</Link>
)
}
\`\`\`
And here's what a function style looks like:
\`\`\`tsx
function Component() {
return (
<Link to="/blog/$postId" params={(prev) => ({ ...prev, postId: '123' })}>
Post 123
</Link>
)
}
\`\`\`
Notice that the function style is useful when you need to persist params that are already in the URL for other routes. This is because the function style will receive the current params as an argument, allowing you to modify them as needed and return the final params object.
## Prefixes and Suffixes for Path Params
You can also use **prefixes** and **suffixes** with path params to create more complex routing patterns. This allows you to match specific URL structures while still capturing the dynamic segments.
When using either prefixes or suffixes, you can define them by wrapping the path param in curly braces \`{}\` and placing the prefix or suffix before or after the variable name.
### Defining Prefixes
Prefixes are defined by placing the prefix text outside the curly braces before the variable name. For example, if you want to match a URL that starts with \`post-\` followed by a post ID, you can define it like this:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/posts/post-{$postId}.tsx"
export const Route = createFileRoute('/posts/post-{$postId}')({
component: PostComponent,
})
function PostComponent() {
const { postId } = Route.useParams()
// postId will be the value after 'post-'
return <div>Post ID: {postId}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts/post-{$postId}.tsx"
export const Route = createFileRoute('/posts/post-{$postId}')({
component: PostComponent,
})
function PostComponent() {
const params = Route.useParams()
// postId will be the value after 'post-'
return <div>Post ID: {params().postId}</div>
}
\`\`\`
<!-- ::end:framework -->
You can even combines prefixes with wildcard routes to create more complex patterns:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/on-disk/storage-{$postId}/$.tsx"
export const Route = createFileRoute('/on-disk/storage-{$postId}/$')({
component: StorageComponent,
})
function StorageComponent() {
const { _splat } = Route.useParams()
// _splat, will be value after 'storage-'
// i.e. my-drive/documents/foo.txt
return <div>Storage Location: /{_splat}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/on-disk/storage-{$postId}/$.tsx"
export const Route = createFileRoute('/on-disk/storage-{$postId}/$')({
component: StorageComponent,
})
function StorageComponent() {
const params = Route.useParams()
// _splat, will be value after 'storage-'
// i.e. my-drive/documents/foo.txt
return <div>Storage Location: /{params()._splat}</div>
}
\`\`\`
<!-- ::end:framework -->
### Defining Suffixes
Suffixes are defined by placing the suffix text outside the curly braces after the variable name. For example, if you want to match a URL a filename that ends with \`txt\`, you can define it like this:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/files/{$fileName}[.]txt.tsx"
export const Route = createFileRoute('/files/{$fileName}.txt')({
component: FileComponent,
})
function FileComponent() {
const { fileName } = Route.useParams()
// fileName will be the value before 'txt'
return <div>File Name: {fileName}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/files/{$fileName}[.]txt.tsx"
export const Route = createFileRoute('/files/{$fileName}.txt')({
component: FileComponent,
})
function FileComponent() {
const params = Route.useParams()
// fileName will be the value before 'txt'
return <div>File Name: {params().fileName}</div>
}
\`\`\`
<!-- ::end:framework -->
You can also combine suffixes with wildcards for more complex routing patterns:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/files/{$}[.]txt.tsx"
export const Route = createFileRoute('/files/{$}.txt')({
component: FileComponent,
})
function FileComponent() {
const { _splat } = Route.useParams()
// _splat will be the value before '.txt'
return <div>File Splat: {_splat}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/files/{$}[.]txt.tsx"
export const Route = createFileRoute('/files/{$}.txt')({
component: FileComponent,
})
function FileComponent() {
const params = Route.useParams()
// _splat will be the value before '.txt'
return <div>File Splat: {params()._splat}</div>
}
\`\`\`
<!-- ::end:framework -->
### Combining Prefixes and Suffixes
You can combine both prefixes and suffixes to create very specific routing patterns. For example, if you want to match a URL that starts with \`user-\` and ends with \`.json\`, you can define it like this:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/users/user-{$userId}[.]json.tsx"
export const Route = createFileRoute('/users/user-{$userId}.json')({
component: UserComponent,
})
function UserComponent() {
const { userId } = Route.useParams()
// userId will be the value between 'user-' and '.json'
return <div>User ID: {userId}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/users/user-{$userId}[.]json.tsx"
export const Route = createFileRoute('/users/user-{$userId}.json')({
component: UserComponent,
})
function UserComponent() {
const params = Route.useParams()
// userId will be the value between 'user-' and '.json'
return <div>User ID: {params().userId}</div>
}
\`\`\`
<!-- ::end:framework -->
Similar to the previous examples, you can also use wildcards with prefixes and suffixes. Go wild!
## Optional Path Parameters
Optional path parameters allow you to define route segments that may or may not be present in the URL. They use the \`{-$paramName}\` syntax and provide flexible routing patterns where certain parameters are optional.
### Defining Optional Parameters
Optional path parameters are defined using curly braces with a dash prefix: \`{-$paramName}\`
\`\`\`tsx
// Single optional parameter
// src/routes/posts/{-$category}.tsx
export const Route = createFileRoute('/posts/{-$category}')({
component: PostsComponent,
})
// Multiple optional parameters
// src/routes/posts/{-$category}/{-$slug}.tsx
export const Route = createFileRoute('/posts/{-$category}/{-$slug}')({
component: PostComponent,
})
// Mixed required and optional parameters
// src/routes/users/$id/{-$tab}.tsx
export const Route = createFileRoute('/users/$id/{-$tab}')({
component: UserComponent,
})
\`\`\`
### How Optional Parameters Work
Optional parameters create flexible URL patterns:
- \`/posts/{-$category}\` matches both \`/posts\` and \`/posts/tech\`
- \`/posts/{-$category}/{-$slug}\` matches \`/posts\`, \`/posts/tech\`, and \`/posts/tech/hello-world\`
- \`/users/$id/{-$tab}\` matches \`/users/123\` and \`/users/123/settings\`
When an optional parameter is not present in the URL, its value will be \`undefined\` in your route handlers and components.
### Accessing Optional Parameters
Optional parameters work exactly like regular parameters in your components, but their values may be \`undefined\`:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/posts/{-$category}.tsx"
function PostsComponent() {
const { category } = Route.useParams()
return <div>{category ? \`Posts in \${category}\` : 'All Posts'}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts/{-$category}.tsx"
function PostsComponent() {
const params = Route.useParams()
return (
<div>
{params().category ? \`Posts in \${params().category}\` : 'All Posts'}
</div>
)
}
\`\`\`
<!-- ::end:framework -->
### Optional Parameters in Loaders
Optional parameters are available in loaders and may be \`undefined\`:
\`\`\`tsx
export const Route = createFileRoute('/posts/{-$category}')({
loader: async ({ params }) => {
// params.category might be undefined
return fetchPosts({ category: params.category })
},
})
\`\`\`
### Optional Parameters in beforeLoad
Optional parameters work in \`beforeLoad\` handlers as well:
\`\`\`tsx
export const Route = createFileRoute('/posts/{-$category}')({
beforeLoad: async ({ params }) => {
if (params.category) {
// Validate category exists
await validateCategory(params.category)
}
},
})
\`\`\`
### Advanced Optional Parameter Patterns
#### With Prefix and Suffix
Optional parameters support prefix and suffix patterns:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/files/prefix{-$name}[.]txt.tsx"
// Route: /files/prefix{-$name}.txt
// Matches: /files/prefix.txt and /files/prefixdocument.txt
export const Route = createFileRoute('/files/prefix{-$name}.txt')({
component: FileComponent,
})
function FileComponent() {
const { name } = Route.useParams()
return <div>File: {name || 'default'}</div>
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/files/prefix{-$name}[.]txt.tsx"
// Route: /files/prefix{-$name}.txt
// Matches: /files/prefix.txt and /files/prefixdocument.txt
export const Route = createFileRoute('/files/prefix{-$name}.txt')({
component: FileComponent,
})
function FileComponent() {
const params = Route.useParams()
return <div>File: {params().name || 'default'}</div>
}
\`\`\`
<!-- ::end:framework -->
#### All Optional Parameters
You can create routes where all parameters are optional:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/{-$year}/{-$month}/{-$day}.tsx"
// Route: /{-$year}/{-$month}/{-$day}
// Matches: /, /2023, /2023/12, /2023/12/25
export const Route = createFileRoute('/{-$year}/{-$month}/{-$day}')({
component: DateComponent,
})
function DateComponent() {
const { year, month, day } = Route.useParams()
if (!year) return <div>Select a year</div>
if (!month) return <div>Year: {year}</div>
if (!day)
return (
<div>
Month: {year}/{month}
</div>
)
return (
<div>
Date: {year}/{month}/{day}
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/{-$year}/{-$month}/{-$day}.tsx"
// Route: /{-$year}/{-$month}/{-$day}
// Matches: /, /2023, /2023/12, /2023/12/25
export const Route = createFileRoute('/{-$year}/{-$month}/{-$day}')({
component: DateComponent,
})
function DateComponent() {
const params = Route.useParams()
if (!params().year) return <div>Select a year</div>
if (!params().month) return <div>Year: {params().year}</div>
if (!params().day)
return (
<div>
Month: {params().year}/{params().month}
</div>
)
return (
<div>
Date: {params().year}/{params().month}/{params().day}
</div>
)
}
\`\`\`
<!-- ::end:framework -->
#### Optional Parameters with Wildcards
Optional parameters can be combined with wildcards for complex routing patterns:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/docs/{-$version}/$.tsx"
// Route: /docs/{-$version}/$
// Matches: /docs/extra/path, /docs/v2/extra/path
export const Route = createFileRoute('/docs/{-$version}/$')({
component: DocsComponent,
})
function DocsComponent() {
const { version } = Route.useParams()
const { _splat } = Route.useParams()
return (
<div>
Version: {version || 'latest'}
Path: {_splat}
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/docs/{-$version}/$.tsx"
// Route: /docs/{-$version}/$
// Matches: /docs/extra/path, /docs/v2/extra/path
export const Route = createFileRoute('/docs/{-$version}/$')({
component: DocsComponent,
})
function DocsComponent() {
const params = Route.useParams()
return (
<div>
Version: {params().version || 'latest'}
Path: {params()._splat}
</div>
)
}
\`\`\`
<!-- ::end:framework -->
### Navigating with Optional Parameters
When navigating to routes with optional parameters, you have fine-grained control over which parameters to include:
\`\`\`tsx
function Navigation() {
return (
<div>
{/* Navigate with optional parameter */}
<Link to="/posts/{-$category}" params={{ category: 'tech' }}>
Tech Posts
</Link>
{/* Navigate without optional parameter */}
<Link to="/posts/{-$category}" params={{ category: undefined }}>
All Posts
</Link>
{/* Navigate with multiple optional parameters */}
<Link
to="/posts/{-$category}/{-$slug}"
params={{ category: 'tech', slug: 'react-tips' }}
>
Specific Post
</Link>
</div>
)
}
\`\`\`
### Type Safety with Optional Parameters
TypeScript provides full type safety for optional parameters:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/posts/{-$category}.tsx"
function PostsComponent() {
// TypeScript knows category might be undefined
const { category } = Route.useParams() // category: string | undefined
// Safe navigation
const categoryUpper = category?.toUpperCase()
return <div>{categoryUpper || 'All Categories'}</div>
}
// Navigation is type-safe and flexible
<Link
to="/posts/{-$category}"
params={{ category: 'tech' }} // β Valid - string
>
Tech Posts
</Link>
<Link
to="/posts/{-$category}"
params={{ category: 123 }} // β Valid - number (auto-stringified)
>
Category 123
</Link>
\`\`\`
# Solid
\`\`\`tsx title="src/routes/posts/{-$category}.tsx"
function PostsComponent() {
// TypeScript knows category might be undefined
const params = Route.useParams() // category: string | undefined
// Safe navigation
const categoryUpper = params().category?.toUpperCase()
return <div>{categoryUpper || 'All Categories'}</div>
}
// Navigation is type-safe and flexible
<Link
to="/posts/{-$category}"
params={{ category: 'tech' }} // β Valid - string
>
Tech Posts
</Link>
<Link
to="/posts/{-$category}"
params={{ category: 123 }} // β Valid - number (auto-stringified)
>
Category 123
</Link>
\`\`\`
<!-- ::end:framework -->
## Internationalization (i18n) with Optional Path Parameters
Optional path parameters are excellent for implementing internationalization (i18n) routing patterns. You can use prefix patterns to handle multiple languages while maintaining clean, SEO-friendly URLs.
### Prefix-based i18n
Use optional language prefixes to support URLs like \`/en/about\`, \`/fr/about\`, or just \`/about\` (default language):
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/{-$locale}/about.tsx"
// Route: /{-$locale}/about
export const Route = createFileRoute('/{-$locale}/about')({
component: AboutComponent,
})
function AboutComponent() {
const { locale } = Route.useParams()
const currentLocale = locale || 'en' // Default to English
const content = {
en: { title: 'About Us', description: 'Learn more about our company.' },
fr: {
title: 'Γ Propos',
description: 'En savoir plus sur notre entreprise.',
},
es: {
title: 'Acerca de',
description: 'Conoce mΓ‘s sobre nuestra empresa.',
},
}
return (
<div>
<h1>{content[currentLocale]?.title}</h1>
<p>{content[currentLocale]?.description}</p>
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/{-$locale}/about.tsx"
// Route: /{-$locale}/about
export const Route = createFileRoute('/{-$locale}/about')({
component: AboutComponent,
})
function AboutComponent() {
const params = Route.useParams()
const currentLocale = params().locale || 'en' // Default to English
const content = {
en: { title: 'About Us', description: 'Learn more about our company.' },
fr: {
title: 'Γ Propos',
description: 'En savoir plus sur notre entreprise.',
},
es: {
title: 'Acerca de',
description: 'Conoce mΓ‘s sobre nuestra empresa.',
},
}
return (
<div>
<h1>{content[currentLocale]?.title}</h1>
<p>{content[currentLocale]?.description}</p>
</div>
)
}
\`\`\`
<!-- ::end:framework -->
This pattern matches:
- \`/about\` (default locale)
- \`/en/about\` (explicit English)
- \`/fr/about\` (French)
- \`/es/about\` (Spanish)
### Complex i18n Patterns
Combine optional parameters for more sophisticated i18n routing:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/{-$locale}/blog/{-$category}/$slug.tsx"
// Route: /{-$locale}/blog/{-$category}/$slug
export const Route = createFileRoute('/{-$locale}/blog/{-$category}/$slug')({
beforeLoad: async ({ params }) => {
const locale = params.locale || 'en'
const category = params.category
// Validate locale and category
const validLocales = ['en', 'fr', 'es', 'de']
if (locale && !validLocales.includes(locale)) {
throw new Error('Invalid locale')
}
return { locale, category }
},
loader: async ({ params, context }) => {
const { locale } = context
const { slug, category } = params
return fetchBlogPost({ slug, category, locale })
},
component: BlogPostComponent,
})
function BlogPostComponent() {
const { locale, category, slug } = Route.useParams()
const data = Route.useLoaderData()
return (
<article>
<h1>{data.title}</h1>
<p>
Category: {category || 'All'} | Language: {locale || 'en'}
</p>
<div>{data.content}</div>
</article>
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/{-$locale}/blog/{-$category}/$slug.tsx"
// Route: /{-$locale}/blog/{-$category}/$slug
export const Route = createFileRoute('/{-$locale}/blog/{-$category}/$slug')({
beforeLoad: async ({ params }) => {
const locale = params.locale || 'en'
const category = params.category
// Validate locale and category
const validLocales = ['en', 'fr', 'es', 'de']
if (locale && !validLocales.includes(locale)) {
throw new Error('Invalid locale')
}
return { locale, category }
},
loader: async ({ params, context }) => {
const { locale } = context
const { slug, category } = params
return fetchBlogPost({ slug, category, locale })
},
component: BlogPostComponent,
})
function BlogPostComponent() {
const params = Route.useParams()
const data = Route.useLoaderData()
return (
<article>
<h1>{data.title}</h1>
<p>
Category: {params().category || 'All'} | Language:{' '}
{params().locale || 'en'}
</p>
<div>{data.content}</div>
</article>
)
}
\`\`\`
<!-- ::end:framework -->
This supports URLs like:
- \`/blog/tech/my-post\` (default locale, tech category)
- \`/fr/blog/my-post\` (French, no category)
- \`/en/blog/tech/my-post\` (explicit English, tech category)
- \`/es/blog/tecnologia/mi-post\` (Spanish, Spanish category)
### Language Navigation
Create language switchers using optional i18n parameters with function-style params:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/components/LanguageSwitcher.tsx"
function LanguageSwitcher() {
const currentParams = useParams({ strict: false })
const languages = [
{ code: 'en', name: 'English' },
{ code: 'fr', name: 'Français' },
{ code: 'es', name: 'EspaΓ±ol' },
]
return (
<div className="language-switcher">
{languages.map(({ code, name }) => (
<Link
key={code}
to="/{-$locale}/blog/{-$category}/$slug"
params={(prev) => ({
...prev,
locale: code === 'en' ? undefined : code, // Remove 'en' for clean URLs
})}
className={currentParams.locale === code ? 'active' : ''}
>
{name}
</Link>
))}
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/components/LanguageSwitcher.tsx"
function LanguageSwitcher() {
const currentParams = useParams({ strict: false })
const languages = [
{ code: 'en', name: 'English' },
{ code: 'fr', name: 'Français' },
{ code: 'es', name: 'EspaΓ±ol' },
]
return (
<div class="language-switcher">
{languages.map(({ code, name }) => (
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={(prev) => ({
...prev,
locale: code === 'en' ? undefined : code, // Remove 'en' for clean URLs
})}
class={currentParams().locale === code ? 'active' : ''}
>
{name}
</Link>
))}
</div>
)
}
\`\`\`
<!-- ::end:framework -->
You can also create more sophisticated language switching logic:
<!-- ::start:framework -->
# React
\`\`\`tsx
function AdvancedLanguageSwitcher() {
const currentParams = useParams({ strict: false })
const handleLanguageChange = (newLocale: string) => {
return (prev: any) => {
// Preserve all existing params but update locale
const updatedParams = { ...prev }
if (newLocale === 'en') {
// Remove locale for clean English URLs
delete updatedParams.locale
} else {
updatedParams.locale = newLocale
}
return updatedParams
}
}
return (
<div className="language-switcher">
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={handleLanguageChange('fr')}
>
Français
</Link>
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={handleLanguageChange('es')}
>
EspaΓ±ol
</Link>
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={handleLanguageChange('en')}
>
English
</Link>
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx
function AdvancedLanguageSwitcher() {
const currentParams = useParams({ strict: false })
const handleLanguageChange = (newLocale: string) => {
return (prev: any) => {
// Preserve all existing params but update locale
const updatedParams = { ...prev }
if (newLocale === 'en') {
// Remove locale for clean English URLs
delete updatedParams.locale
} else {
updatedParams.locale = newLocale
}
return updatedParams
}
}
return (
<div class="language-switcher">
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={handleLanguageChange('fr')}
>
Français
</Link>
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={handleLanguageChange('es')}
>
EspaΓ±ol
</Link>
<Link
to="/{-$locale}/blog/{-$category}/$slug"
params={handleLanguageChange('en')}
>
English
</Link>
</div>
)
}
\`\`\`
<!-- ::end:framework -->
### Advanced i18n with Optional Parameters
Organize i18n routes using optional parameters for flexible locale handling:
<!-- ::start:framework -->
# React
\`\`\`tsx
// Route structure:
// routes/
// {-$locale}/
// index.tsx // /, /en, /fr
// about.tsx // /about, /en/about, /fr/about
// blog/
// index.tsx // /blog, /en/blog, /fr/blog
// $slug.tsx // /blog/post, /en/blog/post, /fr/blog/post
// routes/{-$locale}/index.tsx
export const Route = createFileRoute('/{-$locale}/')({
component: HomeComponent,
})
function HomeComponent() {
const { locale } = Route.useParams()
const isRTL = ['ar', 'he', 'fa'].includes(locale || '')
return (
<div dir={isRTL ? 'rtl' : 'ltr'}>
<h1>Welcome ({locale || 'en'})</h1>
{/* Localized content */}
</div>
)
}
// routes/{-$locale}/about.tsx
export const Route = createFileRoute('/{-$locale}/about')({
component: AboutComponent,
})
\`\`\`
# Solid
\`\`\`tsx
// Route structure:
// routes/
// {-$locale}/
// index.tsx // /, /en, /fr
// about.tsx // /about, /en/about, /fr/about
// blog/
// index.tsx // /blog, /en/blog, /fr/blog
// $slug.tsx // /blog/post, /en/blog/post, /fr/blog/post
// routes/{-$locale}/index.tsx
export const Route = createFileRoute('/{-$locale}/')({
component: HomeComponent,
})
function HomeComponent() {
const params = Route.useParams()
const isRTL = ['ar', 'he', 'fa'].includes(params().locale || '')
return (
<div dir={isRTL ? 'rtl' : 'ltr'}>
<h1>Welcome ({params().locale || 'en'})</h1>
{/* Localized content */}
</div>
)
}
// routes/{-$locale}/about.tsx
export const Route = createFileRoute('/{-$locale}/about')({
component: AboutComponent,
})
\`\`\`
<!-- ::end:framework -->
### SEO and Canonical URLs
Handle SEO for i18n routes properly:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/{-$locale}/products/$id.tsx"
export const Route = createFileRoute('/{-$locale}/products/$id')({
component: ProductComponent,
head: ({ params, loaderData }) => {
const locale = params.locale || 'en'
const product = loaderData
return {
title: product.title[locale] || product.title.en,
meta: [
{
name: 'description',
content: product.description[locale] || product.description.en,
},
{
property: 'og:locale',
content: locale,
},
],
links: [
// Canonical URL (always use default locale format)
{
rel: 'canonical',
href: \`https://example.com/products/\${params.id}\`,
},
// Alternate language versions
{
rel: 'alternate',
hreflang: 'en',
href: \`https://example.com/products/\${params.id}\`,
},
{
rel: 'alternate',
hreflang: 'fr',
href: \`https://example.com/fr/products/\${params.id}\`,
},
{
rel: 'alternate',
hreflang: 'es',
href: \`https://example.com/es/products/\${params.id}\`,
},
],
}
},
})
\`\`\`
# Solid
\`\`\`tsx title="src/routes/{-$locale}/products/$id.tsx"
export const Route = createFileRoute('/{-$locale}/products/$id')({
component: ProductComponent,
head: ({ params, loaderData }) => {
const locale = params.locale || 'en'
const product = loaderData
return {
title: product.title[locale] || product.title.en,
meta: [
{
name: 'description',
content: product.description[locale] || product.description.en,
},
{
property: 'og:locale',
content: locale,
},
],
links: [
// Canonical URL (always use default locale format)
{
rel: 'canonical',
href: \`https://example.com/products/\${params.id}\`,
},
// Alternate language versions
{
rel: 'alternate',
hreflang: 'en',
href: \`https://example.com/products/\${params.id}\`,
},
{
rel: 'alternate',
hreflang: 'fr',
href: \`https://example.com/fr/products/\${params.id}\`,
},
{
rel: 'alternate',
hreflang: 'es',
href: \`https://example.com/es/products/\${params.id}\`,
},
],
}
},
})
\`\`\`
<!-- ::end:framework -->
### Type Safety for i18n
Ensure type safety for your i18n implementations:
<!-- ::start:framework -->
# React
\`\`\`tsx title="src/routes/{-$locale}/shop/{-$category}.tsx"
// Define supported locales
type Locale = 'en' | 'fr' | 'es' | 'de'
// Type-safe locale validation
function validateLocale(locale: string | undefined): locale is Locale {
return ['en', 'fr', 'es', 'de'].includes(locale as Locale)
}
export const Route = createFileRoute('/{-$locale}/shop/{-$category}')({
beforeLoad: async ({ params }) => {
const { locale } = params
// Type-safe locale validation
if (locale && !validateLocale(locale)) {
throw redirect({
to: '/shop/{-$category}',
params: { category: params.category },
})
}
return {
locale: (locale as Locale) || 'en',
isDefaultLocale: !locale || locale === 'en',
}
},
component: ShopComponent,
})
function ShopComponent() {
const { locale, category } = Route.useParams()
const { isDefaultLocale } = Route.useRouteContext()
// TypeScript knows locale is Locale | undefined
// and we have validated it in beforeLoad
return (
<div>
<h1>Shop {category ? \`- \${category}\` : ''}</h1>
<p>Language: {locale || 'en'}</p>
{!isDefaultLocale && (
<Link to="/shop/{-$category}" params={{ category }}>
View in English
</Link>
)}
</div>
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/routes/{-$locale}/shop/{-$category}.tsx"
// Define supported locales
type Locale = 'en' | 'fr' | 'es' | 'de'
// Type-safe locale validation
function validateLocale(locale: string | undefined): locale is Locale {
return ['en', 'fr', 'es', 'de'].includes(locale as Locale)
}
export const Route = createFileRoute('/{-$locale}/shop/{-$category}')({
beforeLoad: async ({ params }) => {
const { locale } = params
// Type-safe locale validation
if (locale && !validateLocale(locale)) {
throw redirect({
to: '/shop/{-$category}',
params: { category: params.category },
})
}
return {
locale: (locale as Locale) || 'en',
isDefaultLocale: !locale || locale === 'en',
}
},
component: ShopComponent,
})
function ShopComponent() {
const params = Route.useParams()
const routeContext = Route.useRouteContext()
// TypeScript knows locale is Locale | undefined
// and we have validated it in beforeLoad
return (
<div>
<h1>Shop {params().category ? \`- \${params().category}\` : ''}</h1>
<p>Language: {params().locale || 'en'}</p>
{!routeContext().isDefaultLocale && (
<Link to="/shop/{-$category}" params={{ category: params().category }}>
View in English
</Link>
)}
</div>
)
}
\`\`\`
<!-- ::end:framework -->
Optional path parameters provide a powerful and flexible foundation for implementing internationalization in your TanStack Router applications. Whether you prefer prefix-based or combined approaches, you can create clean, SEO-friendly URLs while maintaining excellent developer experience and type safety.
## Allowed Characters
By default, path params are escaped with \`encodeURIComponent\`. If you want to allow other valid URI characters (e.g. \`@\` or \`+\`), you can specify that in your [RouterOptions](../api/router/RouterOptionsType.md#pathparamsallowedcharacters-property).
Example usage:
\`\`\`tsx
const router = createRouter({
// ...
pathParamsAllowedCharacters: ['@'],
})
\`\`\`
The following is the list of accepted allowed characters:
- \`;\`
- \`:\`
- \`@\`
- \`&\`
- \`=\`
- \`+\`
- \`$\`
- \`,\`
# Preloading
Preloading in TanStack Router is a way to load a route before the user actually navigates to it. This is useful for routes that are likely to be visited by the user next. For example, if you have a list of posts and the user is likely to click on one of them, you can preload the post route so that it's ready to go when the user clicks on it.
## Supported Preloading Strategies
- Intent
- Preloading by **"intent"** works by using hover and touch start events on \`<Link>\` components to preload the dependencies for the destination route.
- This strategy is useful for preloading routes that the user is likely to visit next.
- Viewport Visibility
- Preloading by **"viewport**" works by using the Intersection Observer API to preload the dependencies for the destination route when the \`<Link>\` component is in the viewport.
- This strategy is useful for preloading routes that are below the fold or off-screen.
- Render
- Preloading by **"render"** works by preloading the dependencies for the destination route as soon as the \`<Link>\` component is rendered in the DOM.
- This strategy is useful for preloading routes that are always needed.
## How long does preloaded data stay in memory?
Preloaded route matches are temporarily cached in memory with a few important caveats:
- **Unused preloaded data is removed after 30 seconds by default.** This can be configured by setting the \`defaultPreloadMaxAge\` option on your router.
- **Obviously, when a route is loaded, its preloaded version is promoted to the router's normal pending matches state.**
If you need more control over preloading, caching and/or garbage collection of preloaded data, you should use an external caching library like [TanStack Query](https://tanstack.com/query).
The simplest way to preload routes for your application is to set the \`defaultPreload\` option to \`intent\` for your entire router:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
const router = createRouter({
// ...
defaultPreload: 'intent',
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouter } from '@tanstack/solid-router'
const router = createRouter({
// ...
defaultPreload: 'intent',
})
\`\`\`
<!-- ::end:framework -->
This will turn on \`intent\` preloading by default for all \`<Link>\` components in your application. You can also set the \`preload\` prop on individual \`<Link>\` components to override the default behavior.
## Preload Delay
By default, preloading will start after **50ms** of the user hovering or touching a \`<Link>\` component. You can change this delay by setting the \`defaultPreloadDelay\` option on your router:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
const router = createRouter({
// ...
defaultPreloadDelay: 100,
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouter } from '@tanstack/solid-router'
const router = createRouter({
// ...
defaultPreloadDelay: 100,
})
\`\`\`
<!-- ::end:framework -->
You can also set the \`preloadDelay\` prop on individual \`<Link>\` components to override the default behavior on a per-link basis.
## Built-in Preloading & \`preloadStaleTime\`
If you're using the built-in loaders, you can control how long preloaded data is considered fresh until another preload is triggered by setting either \`routerOptions.defaultPreloadStaleTime\` or \`routeOptions.preloadStaleTime\` to a number of milliseconds. **By default, preloaded data is considered fresh for 30 seconds.**.
To change this, you can set the \`defaultPreloadStaleTime\` option on your router:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
const router = createRouter({
// ...
defaultPreloadStaleTime: 10_000,
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouter } from '@tanstack/solid-router'
const router = createRouter({
// ...
defaultPreloadStaleTime: 10_000,
})
\`\`\`
<!-- ::end:framework -->
Or, you can use the \`routeOptions.preloadStaleTime\` option on individual routes:
\`\`\`tsx
// src/routes/posts.$postId.tsx
export const Route = createFileRoute('/posts/$postId')({
loader: async ({ params }) => fetchPost(params.postId),
// Preload the route again if the preload cache is older than 10 seconds
preloadStaleTime: 10_000,
})
\`\`\`
## Preloading with External Libraries
When integrating external caching libraries like React Query, which have their own mechanisms for determining stale data, you may want to override the default preloading and stale-while-revalidate logic of TanStack Router. These libraries often use options like staleTime to control the freshness of data.
To customize the preloading behavior in TanStack Router and fully leverage your external library's caching strategy, you can bypass the built-in caching by setting routerOptions.defaultPreloadStaleTime or routeOptions.preloadStaleTime to 0. This ensures that all preloads are marked as stale internally, and loaders are always invoked, allowing your external library, such as React Query, to manage data loading and caching.
For example:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
const router = createRouter({
// ...
defaultPreloadStaleTime: 0,
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouter } from '@tanstack/solid-router'
const router = createRouter({
// ...
defaultPreloadStaleTime: 0,
})
\`\`\`
<!-- ::end:framework -->
This would then allow you, for instance, to use an option like React Query's \`staleTime\` to control the freshness of your preloads.
## Preloading Manually
If you need to manually preload a route, you can use the router's \`preloadRoute\` method. It accepts a standard TanStack \`NavigateOptions\` object and returns a promise that resolves when the route is preloaded.
<!-- ::start:framework -->
# React
\`\`\`tsx
function Component() {
const router = useRouter()
useEffect(() => {
async function preload() {
try {
const matches = await router.preloadRoute({
to: postRoute,
params: { id: 1 },
})
} catch (err) {
// Failed to preload route
}
}
preload()
}, [router])
return <div />
}
\`\`\`
# Solid
\`\`\`tsx
function Component() {
const router = useRouter()
createEffect(() => {
async function preload() {
try {
const matches = await router.preloadRoute({
to: postRoute,
params: { id: 1 },
})
} catch (err) {
// Failed to preload route
}
}
preload()
})
return <div />
}
\`\`\`
<!-- ::end:framework -->
If you need to preload only the JS chunk of a route, you can use the router's \`loadRouteChunk\` method. It accepts a route object and returns a promise that resolves when the route chunk is loaded.
<!-- ::start:framework -->
# React
\`\`\`tsx
function Component() {
const router = useRouter()
useEffect(() => {
async function preloadRouteChunks() {
try {
const postsRoute = router.routesByPath['/posts']
await Promise.all([
router.loadRouteChunk(router.routesByPath['/']),
router.loadRouteChunk(postsRoute),
router.loadRouteChunk(postsRoute.parentRoute),
])
} catch (err) {
// Failed to preload route chunk
}
}
preloadRouteChunks()
}, [router])
return <div />
}
\`\`\`
# Solid
\`\`\`tsx
function Component() {
const router = useRouter()
createEffect(() => {
async function preloadRouteChunks() {
try {
const postsRoute = router.routesByPath['/posts']
await Promise.all([
router.loadRouteChunk(router.routesByPath['/']),
router.loadRouteChunk(postsRoute),
router.loadRouteChunk(postsRoute.parentRoute),
])
} catch (err) {
// Failed to preload route chunk
}
}
preloadRouteChunks()
})
return <div />
}
\`\`\`
<!-- ::end:framework -->
# Render Optimizations
TanStack Router includes several optimizations to ensure your components only re-render when necessary. These optimizations include:
## structural sharing
TanStack Router uses a technique called "structural sharing" to preserve as many references as possible between re-renders, which is particularly useful for state stored in the URL, such as search parameters.
For example, consider a \`details\` route with two search parameters, \`foo\` and \`bar\`, accessed like this:
\`\`\`tsx
const search = Route.useSearch()
\`\`\`
When only \`bar\` is changed by navigating from \`/details?foo=f1&bar=b1\` to \`/details?foo=f1&bar=b2\`, \`search.foo\` will be referentially stable and only \`search.bar\` will be replaced.
## fine-grained selectors
You can access and subscribe to the router state using various hooks like \`useRouterState\`, \`useSearch\`, and others. If you only want a specific component to re-render when a particular subset of the router state such as a subset of the search parameters changes, you can use partial subscriptions with the \`select\` property.
\`\`\`tsx
// component won't re-render when \`bar\` changes
const foo = Route.useSearch({ select: ({ foo }) => foo })
\`\`\`
### structural sharing with fine-grained selectors
The \`select\` function can perform various calculations on the router state, allowing you to return different types of values, such as objects. For example:
\`\`\`tsx
const result = Route.useSearch({
select: (search) => {
return {
foo: search.foo,
hello: \`hello \${search.foo}\`,
}
},
})
\`\`\`
Although this works, it will cause your component to re-render each time, since \`select\` is now returning a new object each time itβs called.
You can avoid this re-rendering issue by using "structural sharing" as described above. By default, structural sharing is turned off to maintain backward compatibility, but this may change in v2.
To enable structural sharing for fine grained selectors, you have two options:
#### Enable it by default in the router options:
\`\`\`tsx
const router = createRouter({
routeTree,
defaultStructuralSharing: true,
})
\`\`\`
#### Enable it per hook usage as shown here:
\`\`\`tsx
const result = Route.useSearch({
select: (search) => {
return {
foo: search.foo,
hello: \`hello \${search.foo}\`,
}
},
structuralSharing: true,
})
\`\`\`
> [!IMPORTANT]
> Structural sharing only works with JSON-compatible data. This means you cannot use \`select\` to return items like class instances if structural sharing is enabled.
In line with TanStack Router's type-safe design, TypeScript will raise an error if you attempt the following:
\`\`\`tsx
const result = Route.useSearch({
select: (search) => {
return {
date: new Date(),
}
},
structuralSharing: true,
})
\`\`\`
If structural sharing is enabled by default in the router options, you can prevent this error by setting \`structuralSharing: false\`.
# Route Masking
Route masking is a way to mask the actual URL of a route that gets persisted to the browser's history and URL bar. This is useful for scenarios where you want to show a different URL than the one that is actually being navigated to and then falling back to the displayed URL when it is shared and (optionally) when the page is reloaded. Here's a few examples:
- Navigating to a modal route like \`/photo/5/modal\`, but masking the actual URL as \`/photos/5\`
- Navigating to a modal route like \`/post/5/comments\`, but masking the actual URL as \`/posts/5\`
- Navigating to a route with the search param \`?showLogin=true\`, but masking the URL to _not_ contain the search param
- Navigating to a route with the search param \`?modal=settings\`, but masking the URL as \`/settings'
Each of these scenarios can be achieved with route masking and even extended to support more advanced patterns like [parallel routes](./parallel-routes.md).
## How does route masking work?
> [!IMPORTANT]
> You **do not** need to understand how route masking works in order to use it. This section is for those who are curious about how it works under the hood. Skip to [How do I use route masking?](#how-do-i-use-route-masking) to learn how to use it!.
Route masking utilizes the \`location.state\` API to store the desired runtime location inside of the location that will get written to the URL. It stores this runtime location under the \`__tempLocation\` state property:
\`\`\`tsx
const location = {
pathname: '/photos/5',
search: '',
hash: '',
state: {
key: 'wesdfs',
__tempKey: 'sadfasd',
__tempLocation: {
pathname: '/photo/5/modal',
search: '',
hash: '',
state: {},
},
},
}
\`\`\`
When the router parses a location from history with the \`location.state.__tempLocation\` property, it will use that location instead of the one that was parsed from the URL. This allows you to navigate to a route like \`/photos/5\` and have the router actually navigate to \`/photo/5/modal\` instead. When this happens, the history location is saved back into the \`location.maskedLocation\` property, just in case we need to know what the **actual URL** is. One example of where this is used is in the Devtools where we detect if a route is masked and show the actual URL instead of the masked one!
Remember, you don't need to worry about any of this. It's all handled for you automatically under the hood!
## How do I use route masking?
Route masking is a simple API that can be used in 2 ways:
- Imperatively via the \`mask\` option available on the \`<Link>\` and \`navigate()\` APIs
- Declaratively via the Router's \`routeMasks\` option
When using either route masking APIs, the \`mask\` option accepts the same navigation object that the \`<Link>\` and \`navigate()\` APIs accept. This means you can use the same \`to\`, \`replace\`, \`state\`, and \`search\` options that you're already familiar with. The only difference is that the \`mask\` option will be used to mask the URL of the route being navigated to.
> π§ The mask option is also **type-safe**! This means that if you're using TypeScript, you'll get type errors if you try to pass an invalid navigation object to the \`mask\` option. Booyah!
### Imperative route masking
The \`<Link>\` and \`navigate()\` APIs both accept a \`mask\` option that can be used to mask the URL of the route being navigated to. Here's an example of using it with the \`<Link>\` component:
\`\`\`tsx
<Link
to="/photos/$photoId/modal"
params={{ photoId: 5 }}
mask={{
to: '/photos/$photoId',
params: {
photoId: 5,
},
}}
>
Open Photo
</Link>
\`\`\`
And here's an example of using it with the \`navigate()\` API:
\`\`\`tsx
const navigate = useNavigate()
function onOpenPhoto() {
navigate({
to: '/photos/$photoId/modal',
params: { photoId: 5 },
mask: {
to: '/photos/$photoId',
params: {
photoId: 5,
},
},
})
}
\`\`\`
### Declarative route masking
In addition to the imperative API, you can also use the Router's \`routeMasks\` option to declaratively mask routes. Instead of needing to pass the \`mask\` option to every \`<Link>\` or \`navigate()\` call, you can instead create a route mask on the Router to mask routes that match a certain pattern. Here's an example of the same route mask from above, but using the \`routeMasks\` option instead:
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRouteMask } from '@tanstack/react-router'
const photoModalToPhotoMask = createRouteMask({
routeTree,
from: '/photos/$photoId/modal',
to: '/photos/$photoId',
params: (prev) => ({
photoId: prev.photoId,
}),
})
const router = createRouter({
routeTree,
routeMasks: [photoModalToPhotoMask],
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouteMask } from '@tanstack/solid-router'
const photoModalToPhotoMask = createRouteMask({
routeTree,
from: '/photos/$photoId/modal',
to: '/photos/$photoId',
params: (prev) => ({
photoId: prev.photoId,
}),
})
const router = createRouter({
routeTree,
routeMasks: [photoModalToPhotoMask],
})
\`\`\`
<!-- ::end:framework -->
When creating a route mask, you'll need to pass 1 argument with at least:
- \`routeTree\` - The route tree that the route mask will be applied to
- \`from\` - The route ID that the route mask will be applied to
- \`...navigateOptions\` - The standard \`to\`, \`search\`, \`params\`, \`replace\`, etc options that the \`<Link>\` and \`navigate()\` APIs accept
> π§ The \`createRouteMask\` option is also **type-safe**! This means that if you're using TypeScript, you'll get type errors if you try to pass an invalid route mask to the \`routeMasks\` option.
## Unmasking when sharing the URL
URLs are automatically unmasked when they are shared since as soon as a URL is detached from your browsers local history stack, the URL masking data is no longer available. Essentially, as soon as you copy and paste a URL out of your history, its masking data is lost... after all, that's the point of masking a URL!
## Local Unmasking Defaults
**By default, URLs are not unmasked when the page is reloaded locally**. Masking data is stored in the \`location.state\` property of the history location, so as long as the history location is still in memory in your history stack, the masking data will be available and the URL will continue to be masked.
## Unmasking on page reload
**As stated above, URLs are not unmasked when the page is reloaded by default**.
If you want to unmask a URL locally when the page is reloaded, you have 3 options, each overriding the previous one in priority if passed:
- Set the Router's default \`unmaskOnReload\` option to \`true\`
- Return the \`unmaskOnReload: true\` option from the masking function when creating a route mask with \`createRouteMask()\`
- Pass the \`unmaskOnReload: true\` option to the \`<Link\`> component or \`navigate()\` API
# Router Context
TanStack Router's router context is a very powerful tool that can be used for dependency injection among many other things. Aptly named, the router context is passed through the router and down through each matching route. At each route in the hierarchy, the context can be modified or added to. Here's a few ways you might use the router context practically:
- Dependency Injection
- You can supply dependencies (e.g. a loader function, a data fetching client, a mutation service) which the route and all child routes can access and use without importing or creating directly.
- Breadcrumbs
- While the main context object for each route is merged as it descends, each route's unique context is also stored making it possible to attach breadcrumbs or methods to each route's context.
- Dynamic meta tag management
- You can attach meta tags to each route's context and then use a meta tag manager to dynamically update the meta tags on the page as the user navigates the site.
These are just suggested uses of the router context. You can use it for whatever you want!
## Typed Router Context
Like everything else, the root router context is strictly typed. This type can be augmented via any route's \`beforeLoad\` option as it is merged down the route match tree. To constrain the type of the root router context, you must use the \`createRootRouteWithContext<YourContextTypeHere>()(routeOptions)\` function to create a new router context instead of the \`createRootRoute()\` function to create your root route. Here's an example:
<!-- ::start:framework -->
# React
\`\`\`tsx
import {
createRootRouteWithContext,
createRouter,
} from '@tanstack/react-router'
interface MyRouterContext {
user: User
}
// Use the routerContext to create your root route
const rootRoute = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
const routeTree = rootRoute.addChildren([
// ...
])
// Use the routerContext to create your router
const router = createRouter({
routeTree,
})
\`\`\`
# Solid
\`\`\`tsx
import {
createRootRouteWithContext,
createRouter,
} from '@tanstack/solid-router'
interface MyRouterContext {
user: User
}
// Use the routerContext to create your root route
const rootRoute = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
const routeTree = rootRoute.addChildren([
// ...
])
// Use the routerContext to create your router
const router = createRouter({
routeTree,
})
\`\`\`
<!-- ::end:framework -->
> [!TIP]
> \`MyRouterContext\` only needs to contain content that will be passed directly to \`createRouter\` below. All other context added in \`beforeLoad\` will be inferred.
## Passing the initial Router Context
The router context is passed to the router at instantiation time. You can pass the initial router context to the router via the \`context\` option:
> [!TIP]
> If your context has any required properties, you will see a TypeScript error if you don't pass them in the initial router context. If all of your context properties are optional, you will not see a TypeScript error and passing the context will be optional. If you don't pass a router context, it defaults to \`{}\`.
<!-- ::start:framework -->
# React
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
// Use the routerContext you created to create your router
const router = createRouter({
routeTree,
context: {
user: {
id: '123',
name: 'John Doe',
},
},
})
\`\`\`
# Solid
\`\`\`tsx
import { createRouter } from '@tanstack/solid-router'
// Use the routerContext you created to create your router
const router = createRouter({
routeTree,
context: {
user: {
id: '123',
name: 'John Doe',
},
},
})
\`\`\`
<!-- ::end:framework -->
### Invalidating the Router Context
If you need to invalidate the context state you are passing into the router, you can call the \`invalidate\` method to tell the router to recompute the context. This is useful when you need to update the context state and have the router recompute the context for all routes.
<!-- ::start:framework -->
# React
\`\`\`tsx
function useAuth() {
const router = useRouter()
const [user, setUser] = useState<User | null>(null)
useEffect(() => {
const unsubscribe = auth.onAuthStateChanged((user) => {
setUser(user)
router.invalidate()
})
return unsubscribe
}, [])
return user
}
\`\`\`
# Solid
\`\`\`tsx
function useAuth() {
const router = useRouter()
const [user, setUser] = createSignal<User | null>(null)
createEffect(() => {
const unsubscribe = auth.onAuthStateChanged((user) => {
setUser(user)
router.invalidate()
})
return unsubscribe
}, [])
return user()
}
\`\`\`
<!-- ::end:framework -->
## Using the Router Context
Once you have defined the router context type, you can use it in your route definitions:
\`\`\`tsx
// src/routes/todos.tsx
export const Route = createFileRoute('/todos')({
component: Todos,
loader: ({ context }) => fetchTodosByUserId(context.user.id),
})
\`\`\`
You can even inject data fetching and mutation implementations themselves! In fact, this is highly recommended π
Let's try this with a simple function to fetch some todos:
\`\`\`tsx
const fetchTodosByUserId = async ({ userId }) => {
const response = await fetch(\`/api/todos?userId=\${userId}\`)
const data = await response.json()
return data
}
const router = createRouter({
routeTree: rootRoute,
context: {
userId: '123',
fetchTodosByUserId,
},
})
\`\`\`
Then, in your route:
\`\`\`tsx
// src/routes/todos.tsx
export const Route = createFileRoute('/todos')({
component: Todos,
loader: ({ context }) => context.fetchTodosByUserId(context.userId),
})
\`\`\`
### How about an external data fetching library?
<!-- ::start:framework -->
# React
\`\`\`tsx
import {
createRootRouteWithContext,
createRouter,
} from '@tanstack/react-router'
interface MyRouterContext {
queryClient: QueryClient
}
const rootRoute = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
const queryClient = new QueryClient()
const router = createRouter({
routeTree: rootRoute,
context: {
queryClient,
},
})
\`\`\`
# Solid
\`\`\`tsx
import {
createRootRouteWithContext,
createRouter,
} from '@tanstack/solid-router'
interface MyRouterContext {
queryClient: QueryClient
}
const rootRoute = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
const queryClient = new QueryClient()
const router = createRouter({
routeTree: rootRoute,
context: {
queryClient,
},
})
\`\`\`
<!-- ::end:framework -->
Then, in your route:
\`\`\`tsx
// src/routes/todos.tsx
export const Route = createFileRoute('/todos')({
component: Todos,
loader: async ({ context }) => {
await context.queryClient.ensureQueryData({
queryKey: ['todos', { userId: user.id }],
queryFn: fetchTodos,
})
},
})
\`\`\`
<!-- ::start:framework -->
# React
## How about using React Context/Hooks?
When trying to use React Context or Hooks in your route's \`beforeLoad\` or \`loader\` functions, it's important to remember React's [Rules of Hooks](https://react.dev/reference/rules/rules-of-hooks). You can't use hooks in a non-React function, so you can't use hooks in your \`beforeLoad\` or \`loader\` functions.
So, how do we use React Context or Hooks in our route's \`beforeLoad\` or \`loader\` functions? We can use the router context to pass down the React Context or Hooks to our route's \`beforeLoad\` or \`loader\` functions.
Let's look at the setup for an example, where we pass down a \`useNetworkStrength\` hook to our route's \`loader\` function:
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/routes/__root.tsx"
// First, make sure the context for the root route is typed
import { createRootRouteWithContext } from '@tanstack/react-router'
import { useNetworkStrength } from '@/hooks/useNetworkStrength'
interface MyRouterContext {
networkStrength: ReturnType<typeof useNetworkStrength>
}
export const Route = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
\`\`\`
<!-- ::end:tabs -->
In this example, we'd instantiate the hook before rendering the router using the \`<RouterProvider />\`. This way, the hook would be called in React-land, therefore adhering to the Rules of Hooks.
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'
export const router = createRouter({
routeTree,
context: {
networkStrength: undefined!, // We'll set this in React-land
},
})
\`\`\`
<!-- ::end:tabs -->
Then, we can call the \`useNetworkStrength\` hook in our \`App\` component and pass the returned value into the router context via the \`<RouterProvider />\`:
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/main.tsx"
import { RouterProvider } from '@tanstack/react-router'
import { router } from './router'
import { useNetworkStrength } from '@/hooks/useNetworkStrength'
function App() {
const networkStrength = useNetworkStrength()
// Inject the returned value from the hook into the router context
return <RouterProvider router={router} context={{ networkStrength }} />
}
// ...
\`\`\`
<!-- ::end:tabs -->
So, now in our route's \`loader\` function, we can access the \`networkStrength\` hook from the router context:
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/routes/posts.tsx"
import { createFileRoute } from '@tanstack/react-router'
export const Route = createFileRoute('/posts')({
component: Posts,
loader: ({ context }) => {
if (context.networkStrength === 'STRONG') {
// Do something
}
},
})
\`\`\`
<!-- ::end:tabs -->
<!-- ::end:framework -->
## Modifying the Router Context
The router context is passed down the route tree and is merged at each route. This means that you can modify the context at each route and the modifications will be available to all child routes. Here's an example:
<!-- ::start:framework -->
# React
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/routes/__root.tsx"
import { createRootRouteWithContext } from '@tanstack/react-router'
interface MyRouterContext {
foo: boolean
}
export const Route = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
\`\`\`
<!-- ::end:tabs -->
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'
const router = createRouter({
routeTree,
context: {
foo: true,
},
})
\`\`\`
<!-- ::end:tabs -->
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/routes/todos.tsx"
import { createFileRoute } from '@tanstack/react-router'
export const Route = createFileRoute('/todos')({
component: Todos,
beforeLoad: () => {
return {
bar: true,
}
},
loader: ({ context }) => {
context.foo // true
context.bar // true
},
})
\`\`\`
<!-- ::end:tabs -->
# Solid
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/routes/__root.tsx"
import { createRootRouteWithContext } from '@tanstack/solid-router'
interface MyRouterContext {
foo: boolean
}
export const Route = createRootRouteWithContext<MyRouterContext>()({
component: App,
})
\`\`\`
<!-- ::end:tabs -->
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/router.tsx"
import { createRouter } from '@tanstack/solid-router'
import { routeTree } from './routeTree.gen'
const router = createRouter({
routeTree,
context: {
foo: true,
},
})
\`\`\`
<!-- ::end:tabs -->
<!-- ::start:tabs variant="files" -->
\`\`\`tsx title="src/routes/todos.tsx"
import { createFileRoute } from '@tanstack/solid-router'
export const Route = createFileRoute('/todos')({
component: Todos,
beforeLoad: () => {
return {
bar: true,
}
},
loader: ({ context }) => {
context.foo // true
context.bar // true
},
})
\`\`\`
<!-- ::end:tabs -->
<!-- ::end:framework -->
## Processing Accumulated Route Context
Context, especially the isolated route \`context\` objects, make it trivial to accumulate and process the route context objects for all matched routes. Here's an example where we use all of the matched route contexts to generate a breadcrumb trail:
\`\`\`tsx title="src/routes/__root.tsx"
export const Route = createRootRoute({
component: () => {
const matches = useRouterState({ select: (s) => s.matches })
const breadcrumbs = matches
.filter((match) => match.context.getTitle)
.map(({ pathname, context }) => {
return {
title: context.getTitle(),
path: pathname,
}
})
// ...
},
})
\`\`\`
Using that same route context, we could also generate a title tag for our page's \`<head>\`:
\`\`\`tsx title="src/routes/__root.tsx"
export const Route = createRootRoute({
component: () => {
const matches = useRouterState({ select: (s) => s.matches })
const matchWithTitle = [...matches]
.reverse()
.find((d) => d.context.getTitle)
const title = matchWithTitle?.context.getTitle() || 'My App'
return (
<html>
<head>
<title>{title}
{/* ... */}
)
},
})
\`\`\`
# Router Events
TanStack Router exposes router lifecycle events through \`router.subscribe\`. This is useful for imperative side effects like analytics, resetting external state, or running DOM-dependent logic after navigation.
## Basic usage
\`router.subscribe\` takes an event name and a listener, then returns an unsubscribe function:
\`\`\`tsx
const unsubscribe = router.subscribe('onResolved', (event) => {
console.info('Navigation finished:', event.toLocation.href)
})
// Later, clean up the listener
unsubscribe()
\`\`\`
## When to use it
\`router.subscribe\` is best for imperative integrations that need to observe navigation without driving rendering:
- Analytics and pageview tracking
- Resetting external caches or mutation state
- Logging navigation timing and transitions
- Running DOM-dependent logic after routes render
If you need reactive UI updates, prefer framework hooks like \`useRouterState\`, \`useSearch\`, and \`useParams\` instead of subscribing manually.
## Available events
TanStack Router emits these lifecycle events:
- \`onBeforeNavigate\` - right before a navigation begins
- \`onBeforeLoad\` - before route loading starts
- \`onLoad\` - after the next location has committed and route matches have loaded
- \`onBeforeRouteMount\` - after loading finishes, just before route components mount
- \`onResolved\` - after the navigation has fully resolved
- \`onRendered\` - after the route has rendered
For the full event payload types, see the [\`RouterEvents\` type](../api/router/RouterEventsType.md).
## Typical event flow
For a normal navigation, the events usually flow like this:
1. \`onBeforeNavigate\`
2. \`onBeforeLoad\`
3. \`onLoad\`
4. \`onBeforeRouteMount\`
5. \`onResolved\`
6. \`onRendered\`
You usually do not need every event. A good rule of thumb is:
- Use \`onBeforeNavigate\` or \`onBeforeLoad\` to observe navigation start
- Use \`onResolved\` for analytics and cleanup after navigation finishes
- Use \`onRendered\` for DOM-dependent work
## Event payload
Navigation events receive location change metadata describing what changed:
\`\`\`tsx
const unsubscribe = router.subscribe('onBeforeNavigate', (event) => {
console.info({
from: event.fromLocation?.href,
to: event.toLocation.href,
pathChanged: event.pathChanged,
hrefChanged: event.hrefChanged,
hashChanged: event.hashChanged,
})
})
\`\`\`
A few useful details:
- \`fromLocation\` can be \`undefined\` on the initial load
- \`pathChanged\` tells you whether the pathname changed
- \`hrefChanged\` includes pathname, search, and hash changes
- \`hashChanged\` is useful for distinguishing hash-only navigations
## Common patterns
### Track pageviews
\`onResolved\` is a good default for analytics because it fires after navigation finishes:
\`\`\`tsx
const unsubscribe = router.subscribe('onResolved', ({ toLocation }) => {
analytics.track('page_view', {
path: toLocation.pathname,
href: toLocation.href,
})
})
\`\`\`
### Clear external mutation state
If you use a mutation library without keyed mutation state, clear it after navigation:
\`\`\`tsx
const unsubscribe = router.subscribe('onResolved', ({ pathChanged }) => {
if (pathChanged) {
mutationCache.clear()
}
})
\`\`\`
### Run DOM-dependent logic
Use \`onRendered\` when your side effect depends on the new route content already being in the DOM:
\`\`\`tsx
const unsubscribe = router.subscribe('onRendered', ({ toLocation }) => {
focusPageHeading(toLocation.pathname)
})
\`\`\`
## Unsubscribing in components
If you subscribe from a component or framework effect, always return the unsubscribe function from your cleanup so the listener is removed when the component unmounts.
## Related APIs
- [\`Router\` type](../api/router/RouterType.md)
- [\`RouterEvents\` type](../api/router/RouterEventsType.md)
- [Data Mutations](./data-mutations.md)
# Scroll Restoration
## Hash/Top-of-Page Scrolling
Out of the box, TanStack Router supports both **hash scrolling** and **top-of-page scrolling** without any additional configuration.
## Scroll-to-top & Nested Scrollable Areas
By default, scroll-to-top mimics the behavior of the browser, which means only the \`window\` itself is scrolled to the top after successful navigation. For many apps however, it's common for the main scrollable area to be a nested div or similar because of advanced layouts. If you would like TanStack Router to also scroll these main scrollable areas for you, you can add selectors to target them using the \`routerOptions.scrollToTopSelectors\`:
\`\`\`tsx
const router = createRouter({
scrollToTopSelectors: ['#main-scrollable-area'],
})
\`\`\`
For complex selectors that cannot be simply resolved using \`document.querySelector(selector)\`, you can pass functions that return HTML elements to \`routerOptions.scrollToTopSelectors\`:
\`\`\`tsx
const selector = () =>
document
.querySelector('#shadowRootParent')
?.shadowRoot?.querySelector('#main-scrollable-area')
const router = createRouter({
scrollToTopSelectors: [selector],
})
\`\`\`
These selectors are handled **in addition to \`window\`** which cannot be disabled currently.
## Scroll Restoration
Scroll restoration is the process of restoring the scroll position of a page when the user navigates back to it. This is normally a built-in feature for standard HTML based websites, but can be difficult to replicate for SPA applications because:
- SPAs typically use the \`history.pushState\` API for navigation, so the browser doesn't know to restore the scroll position natively
- SPAs sometimes render content asynchronously, so the browser doesn't know the height of the page until after it's rendered
- SPAs can sometimes use nested scrollable containers to force specific layouts and features.
Not only that, but it's very common for applications to have multiple scrollable areas within an app, not just the body. For example, a chat application might have a scrollable sidebar and a scrollable chat area. In this case, you would want to restore the scroll position of both areas independently.
To alleviate this problem, TanStack Router provides a scroll restoration component and hook that handle the process of monitoring, caching and restoring scroll positions for you.
It does this by:
- Monitoring the DOM for scroll events
- Registering scrollable areas with the scroll restoration cache
- Listening to the proper router events to know when to cache and restore scroll positions
- Storing scroll positions for each scrollable area in the cache (including \`window\` and \`body\`)
- Restoring scroll positions after successful navigations before DOM paint
That may sound like a lot, but for you, it's as simple as this:
\`\`\`tsx
const router = createRouter({
scrollRestoration: true,
})
\`\`\`
> [!NOTE]
> The \`\` component still works, but has been deprecated.
## Custom Cache Keys
Falling in behind Remix's own Scroll Restoration APIs, you can also customize the key used to cache scroll positions for a given scrollable area using the \`getKey\` option. This could be used, for example, to force the same scroll position to be used regardless of the users browser history.
The \`getKey\` option receives the relevant \`Location\` state from TanStack Router and expects you to return a string to uniquely identify the scrollable measurements for that state.
The default \`getKey\` is \`(location) => location.state.__TSR_key!\`, where \`__TSR_key\` is the unique key generated for each entry in the history.
> Older versions, prior to \`v1.121.34\`, used \`state.key\` as the default key, but this has been deprecated in favor of \`state.__TSR_key\`. For now, \`location.state.key\` will still be available for compatibility, but it will be removed in the next major version.
## Examples
You could sync scrolling to the pathname:
\`\`\`tsx
const router = createRouter({
getScrollRestorationKey: (location) => location.pathname,
})
\`\`\`
You can conditionally sync only some paths, then use the key for the rest:
\`\`\`tsx
const router = createRouter({
getScrollRestorationKey: (location) => {
const paths = ['/', '/chat']
return paths.includes(location.pathname)
? location.pathname
: location.state.__TSR_key!
},
})
\`\`\`
## Preventing Scroll Restoration
Sometimes you may want to prevent scroll restoration from happening. To do this you can utilize the \`resetScroll\` option available on the following APIs:
- \`\`
- \`navigate({ resetScroll: false })\`
- \`redirect({ resetScroll: false })\`
When \`resetScroll\` is set to \`false\`, the scroll position for the next navigation will not be restored (if navigating to an existing history event in the stack) or reset to the top (if it's a new history event in the stack).
## Manual Scroll Restoration
Most of the time, you won't need to do anything special to get scroll restoration to work. However, there are some cases where you may need to manually control scroll restoration. The most common example is **virtualized lists**.
To manually control scroll restoration for virtualized lists within the whole browser window:
\`\`\`tsx
function Component() {
const scrollEntry = useElementScrollRestoration({
getElement: () => window,
})
// Let's use TanStack Virtual to virtualize some content!
const virtualizer = useWindowVirtualizer({
count: 10000,
estimateSize: () => 100,
// We pass the scrollY from the scroll restoration entry to the virtualizer
// as the initial offset
initialOffset: scrollEntry?.scrollY,
})
return (
)
}
\`\`\`
To manually control scroll restoration for a specific element, you can use the \`useElementScrollRestoration\` hook and the \`data-scroll-restoration-id\` DOM attribute:
# React
\`\`\`tsx
function Component() {
// We need a unique ID for manual scroll restoration on a specific element
// It should be as unique as possible for this element across your app
const scrollRestorationId = 'myVirtualizedContent'
// We use that ID to get the scroll entry for this element
const scrollEntry = useElementScrollRestoration({
id: scrollRestorationId,
})
// Let's use TanStack Virtual to virtualize some content!
const virtualizerParentRef = React.useRef(null)
const virtualizer = useVirtualizer({
count: 10000,
getScrollElement: () => virtualizerParentRef.current,
estimateSize: () => 100,
// We pass the scrollY from the scroll restoration entry to the virtualizer
// as the initial offset
initialOffset: scrollEntry?.scrollY,
})
return (
...
)
}
\`\`\`
# Solid
\`\`\`tsx
function Component() {
// We need a unique ID for manual scroll restoration on a specific element
// It should be as unique as possible for this element across your app
const scrollRestorationId = 'myVirtualizedContent'
// We use that ID to get the scroll entry for this element
const scrollEntry = useElementScrollRestoration({
id: scrollRestorationId,
})
// Let's use TanStack Virtual to virtualize some content!
let virtualizerParentRef: any
const virtualizer = createVirtualizer({
count: 10000,
getScrollElement: () => virtualizerParentRef,
estimateSize: () => 100,
// We pass the scrollY from the scroll restoration entry to the virtualizer
// as the initial offset
initialOffset: scrollEntry?.scrollY,
})
return (
...
)
}
\`\`\`
## Scroll Behavior
To control the scroll behavior when navigating between pages, you can use the \`scrollRestorationBehavior\` option. This allows you to make the transition between pages instant instead of a smooth scroll. The global configuration of scroll restoration behavior has the same options as those supported by the browser, which are \`smooth\`, \`instant\`, and \`auto\` (see [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView#behavior) for more information).
\`\`\`tsx
const router = createRouter({
scrollRestorationBehavior: 'instant',
})
\`\`\`
# Search Params
Similar to how TanStack Query made handling server-state in your React and Solid applications a breeze, TanStack Router aims to unlock the power of URL search params in your applications.
> π§ If you are on a really old browser, like IE11, you may need to use a polyfill for \`URLSearchParams\`.
## Why not just use \`URLSearchParams\`?
We get it, you've been hearing a lot of "use the platform" lately and for the most part, we agree. However, we also believe it's important to recognize where the platform falls short for more advanced use-cases and we believe \`URLSearchParams\` is one of these circumstances.
Traditional Search Param APIs usually assume a few things:
- Search params are always strings
- They are _mostly_ flat
- Serializing and deserializing using \`URLSearchParams\` is good enough (Spoiler alert: it's not.)
- Search params modifications are tightly coupled with the URL's pathname and must be updated together, even if the pathname is not changing.
Reality is very different from these assumptions though.
- Search params represent application state, so inevitably, we will expect them to have the same DX associated with other state managers. This means having the capability of distinguishing between primitive value types and efficiently storing and manipulating complex data structures like nested arrays and objects.
- There are many ways to serialize and deserialize state with different tradeoffs. You should be able to choose the best one for your application or at the very least get a better default than \`URLSearchParams\`.
- Immutability & Structural Sharing. Every time you stringify and parse url search params, referential integrity and object identity is lost because each new parse creates a brand new data structure with a unique memory reference. If not properly managed over its lifetime, this constant serialization and parsing can result in unexpected and undesirable performance issues, especially in frameworks like React that choose to track reactivity via immutability or in Solid that normally relies on reconciliation to detect changes from deserialized data sources.
- Search params, while an important part of the URL, do frequently change independently of the URL's pathname. For example, a user may want to change the page number of a paginated list without touching the URL's pathname.
## Search Params, the "OG" State Manager
You've probably seen search params like \`?page=3\` or \`?filter-name=tanner\` in the URL. There is no question that this is truly **a form of global state** living inside of the URL. It's valuable to store specific pieces of state in the URL because:
- Users should be able to:
- Cmd/Ctrl + Click to open a link in a new tab and reliably see the state they expected
- Bookmark and share links from your application with others with assurances that they will see exactly the state as when the link was copied.
- Refresh your app or navigate back and forth between pages without losing their state
- Developers should be able to easily:
- Add, remove or modify state in the URL with the same great DX as other state managers
- Easily validate search params coming from the URL in a format and type that is safe for their application to consume
- Read and write to search params without having to worry about the underlying serialization format
## JSON-first Search Params
To achieve the above, the first step built in to TanStack Router is a powerful search param parser that automatically converts the search string of your URL to structured JSON. This means that you can store any JSON-serializable data structure in your search params and it will be parsed and serialized as JSON. This is a huge improvement over \`URLSearchParams\` which has limited support for array-like structures and nested data.
For example, navigating to the following route:
\`\`\`tsx
const link = (
)
\`\`\`
Will result in the following URL:
\`\`\`
/shop?pageIndex=3&includeCategories=%5B%22electronics%22%2C%22gifts%22%5D&sortBy=price&desc=true
\`\`\`
When this URL is parsed, the search params will be accurately converted back to the following JSON:
\`\`\`json
{
"pageIndex": 3,
"includeCategories": ["electronics", "gifts"],
"sortBy": "price",
"desc": true
}
\`\`\`
If you noticed, there are a few things going on here:
- The first level of the search params is flat and string based, just like \`URLSearchParams\`.
- First level values that are not strings are accurately preserved as actual numbers and booleans.
- Nested data structures are automatically converted to URL-safe JSON strings
> π§ It's common for other tools to assume that search params are always flat and string-based which is why we've chosen to keep things URLSearchParam compliant at the first level. This ultimately means that even though TanStack Router is managing your nested search params as JSON, other tools will still be able to write to the URL and read first-level params normally.
## Validating and Typing Search Params
Despite TanStack Router being able to parse search params into reliable JSON, they ultimately still came from **a user-facing raw-text input**. Similar to other serialization boundaries, this means that before you consume search params, they should be validated into a format that your application can trust and rely on.
### Enter Validation + TypeScript!
TanStack Router provides convenient APIs for validating and typing search params. This all starts with the \`Route\`'s \`validateSearch\` option:
\`\`\`tsx title="src/routes/shop/products.tsx"
type ProductSearchSortOptions = 'newest' | 'oldest' | 'price'
type ProductSearch = {
page: number
filter: string
sort: ProductSearchSortOptions
}
export const Route = createFileRoute('/shop/products')({
validateSearch: (search: Record): ProductSearch => {
// validate and parse the search params into a typed state
return {
page: Number(search?.page ?? 1),
filter: (search.filter as string) || '',
sort: (search.sort as ProductSearchSortOptions) || 'newest',
}
},
})
\`\`\`
In the above example, we're validating the search params of the \`Route\` and returning a typed \`ProductSearch\` object. This typed object is then made available to this route's other options **and any child routes, too!**
### Validating Search Params
The \`validateSearch\` option is a function that is provided the JSON parsed (but non-validated) search params as a \`Record\` and returns a typed object of your choice. It's usually best to provide sensible fallbacks for malformed or unexpected search params so your users' experience stays non-interrupted.
Here's an example:
\`\`\`tsx title="src/routes/shop/products.tsx"
type ProductSearchSortOptions = 'newest' | 'oldest' | 'price'
type ProductSearch = {
page: number
filter: string
sort: ProductSearchSortOptions
}
export const Route = createFileRoute('/shop/products')({
validateSearch: (search: Record): ProductSearch => {
// validate and parse the search params into a typed state
return {
page: Number(search?.page ?? 1),
filter: (search.filter as string) || '',
sort: (search.sort as ProductSearchSortOptions) || 'newest',
}
},
})
\`\`\`
Here's an example using the [Zod](https://zod.dev/) library (but feel free to use any validation library you want) to both validate and type the search params in a single step:
\`\`\`tsx title="src/routes/shop/products.tsx"
import { z } from 'zod'
const productSearchSchema = z.object({
page: z.number().catch(1),
filter: z.string().catch(''),
sort: z.enum(['newest', 'oldest', 'price']).catch('newest'),
})
type ProductSearch = z.infer
export const Route = createFileRoute('/shop/products')({
validateSearch: (search) => productSearchSchema.parse(search),
})
\`\`\`
Because \`validateSearch\` also accepts an object with the \`parse\` property, this can be shortened to:
\`\`\`tsx
validateSearch: productSearchSchema
\`\`\`
In the above example, we used Zod's \`.catch()\` modifier instead of \`.default()\` to avoid showing an error to the user because we firmly believe that if a search parameter is malformed, you probably don't want to halt the user's experience through the app to show a big fat error message. That said, there may be times that you **do want to show an error message**. In that case, you can use \`.default()\` instead of \`.catch()\`.
The underlying mechanics why this works relies on the \`validateSearch\` function throwing an error. If an error is thrown, the route's \`onError\` option will be triggered (and \`error.routerCode\` will be set to \`VALIDATE_SEARCH\` and the \`errorComponent\` will be rendered instead of the route's \`component\` where you can handle the search param error however you'd like.
#### Adapters
When using a library like [Zod](https://zod.dev/) to validate search params you might want to \`transform\` search params before committing the search params to the URL. A common \`zod\` \`transform\` is \`default\` for example.
\`\`\`tsx
import { z } from 'zod'
const productSearchSchema = z.object({
page: z.number().default(1),
filter: z.string().default(''),
sort: z.enum(['newest', 'oldest', 'price']).default('newest'),
})
export const Route = createFileRoute('/shop/products/')({
validateSearch: productSearchSchema,
})
\`\`\`
It might be surprising that when you try to navigate to this route, \`search\` is required. The following \`Link\` will type error as \`search\` is missing.
\`\`\`tsx
\`\`\`
For validation libraries we recommend using adapters which infer the correct \`input\` and \`output\` types.
### Zod
An adapter is provided for [Zod](https://zod.dev/) which will pipe through the correct \`input\` type and \`output\` type.
For Zod v3:
\`\`\`tsx
import { zodValidator } from '@tanstack/zod-adapter'
import { z } from 'zod'
const productSearchSchema = z.object({
page: z.number().default(1),
filter: z.string().default(''),
sort: z.enum(['newest', 'oldest', 'price']).default('newest'),
})
export const Route = createFileRoute('/shop/products/')({
validateSearch: zodValidator(productSearchSchema),
})
\`\`\`
With Zod v4, you should directly use the schema in \`validateSearch\`:
\`\`\`tsx
import { z } from 'zod'
const productSearchSchema = z.object({
page: z.number().default(1),
filter: z.string().default(''),
sort: z.enum(['newest', 'oldest', 'price']).default('newest'),
})
export const Route = createFileRoute('/shop/products/')({
// With Zod v4, we can use the schema without the adapter
validateSearch: productSearchSchema,
})
\`\`\`
The important part here is the following use of \`Link\` no longer requires \`search\` params:
\`\`\`tsx
\`\`\`
In Zod v3, the use of \`catch\` here overrides the types and makes \`page\`, \`filter\` and \`sort\` \`unknown\` causing type loss. We have handled this case by providing a \`fallback\` generic function which retains the types but provides a \`fallback\` value when validation fails:
\`\`\`tsx
import { fallback, zodValidator } from '@tanstack/zod-adapter'
import { z } from 'zod'
const productSearchSchema = z.object({
page: fallback(z.number(), 1).default(1),
filter: fallback(z.string(), '').default(''),
sort: fallback(z.enum(['newest', 'oldest', 'price']), 'newest').default(
'newest',
),
})
export const Route = createFileRoute('/shop/products/')({
validateSearch: zodValidator(productSearchSchema),
})
\`\`\`
Therefore when navigating to this route, \`search\` is optional and retains the correct types.
In Zod v4, schemas may use \`catch\` instead of the fallback and will retain type inference throughout.
While not recommended, it is also possible to configure \`input\` and \`output\` type in case the \`output\` type is more accurate than the \`input\` type:
\`\`\`tsx
const productSearchSchema = z.object({
page: fallback(z.number(), 1).default(1),
filter: fallback(z.string(), '').default(''),
sort: fallback(z.enum(['newest', 'oldest', 'price']), 'newest').default(
'newest',
),
})
export const Route = createFileRoute('/shop/products/')({
validateSearch: zodValidator({
schema: productSearchSchema,
input: 'output',
output: 'input',
}),
})
\`\`\`
This provides flexibility in which type you want to infer for navigation and which types you want to infer for reading search params.
### Valibot
> [!WARNING]
> Router expects the valibot 1.0 package to be installed.
When using [Valibot](https://valibot.dev/) an adapter is not needed to ensure the correct \`input\` and \`output\` types are used for navigation and reading search params. This is because \`valibot\` implements [Standard Schema](https://github.com/standard-schema/standard-schema)
\`\`\`tsx
import * as v from 'valibot'
const productSearchSchema = v.object({
page: v.optional(v.fallback(v.number(), 1), 1),
filter: v.optional(v.fallback(v.string(), ''), ''),
sort: v.optional(
v.fallback(v.picklist(['newest', 'oldest', 'price']), 'newest'),
'newest',
),
})
export const Route = createFileRoute('/shop/products/')({
validateSearch: productSearchSchema,
})
\`\`\`
### Arktype
> [!WARNING]
> Router expects the arktype 2.0-rc package to be installed.
When using [ArkType](https://arktype.io/) an adapter is not needed to ensure the correct \`input\` and \`output\` types are used for navigation and reading search params. This is because [ArkType](https://arktype.io/) implements [Standard Schema](https://github.com/standard-schema/standard-schema)
\`\`\`tsx
import { type } from 'arktype'
const productSearchSchema = type({
page: 'number = 1',
filter: 'string = ""',
sort: '"newest" | "oldest" | "price" = "newest"',
})
export const Route = createFileRoute('/shop/products/')({
validateSearch: productSearchSchema,
})
\`\`\`
### Effect/Schema
When using [Effect/Schema](https://effect.website/docs/schema/introduction/) an adapter is not needed to ensure the correct \`input\` and \`output\` types are used for navigation and reading search params. This is because [Effect/Schema](https://effect.website/docs/schema/standard-schema/) implements [Standard Schema](https://github.com/standard-schema/standard-schema)
\`\`\`tsx
import { Schema as S } from 'effect'
const productSearchSchema = S.standardSchemaV1(
S.Struct({
page: S.NumberFromString.pipe(
S.optional,
S.withDefaults({
constructor: () => 1,
decoding: () => 1,
}),
),
filter: S.String.pipe(
S.optional,
S.withDefaults({
constructor: () => '',
decoding: () => '',
}),
),
sort: S.Literal('newest', 'oldest', 'price').pipe(
S.optional,
S.withDefaults({
constructor: () => 'newest' as const,
decoding: () => 'newest' as const,
}),
),
}),
)
export const Route = createFileRoute('/shop/products/')({
validateSearch: productSearchSchema,
})
\`\`\`
## Reading Search Params
Once your search params have been validated and typed, you're finally ready to start reading and writing to them. There are a few ways to do this in TanStack Router, so let's check them out.
### Using Search Params in Loaders
Please read the [Search Params in Loaders](./data-loading.md#using-loaderdeps-to-access-search-params) section for more information about how to read search params in loaders with the \`loaderDeps\` option.
### Search Params are inherited from Parent Routes
The search parameters and types of parents are merged as you go down the route tree, so child routes also have access to their parent's search params:
\`\`\`tsx title="src/routes/shop/products.tsx"
const productSearchSchema = z.object({
page: z.number().catch(1),
filter: z.string().catch(''),
sort: z.enum(['newest', 'oldest', 'price']).catch('newest'),
})
type ProductSearch = z.infer
export const Route = createFileRoute('/shop/products')({
validateSearch: productSearchSchema,
})
\`\`\`
\`\`\`tsx title="src/routes/shop/products/$productId.tsx"
export const Route = createFileRoute('/shop/products/$productId')({
beforeLoad: ({ search }) => {
search
// ^? ProductSearch β
},
})
\`\`\`
### Search Params in Components
You can access your route's validated search params in your route's \`component\` via the \`useSearch\` hook.
\`\`\`tsx title="src/routes/shop/products.tsx"
export const Route = createFileRoute('/shop/products')({
validateSearch: productSearchSchema,
})
const ProductList = () => {
const { page, filter, sort } = Route.useSearch()
return
...
}
\`\`\`
> [!TIP]
> If your component is code-split, you can use the [getRouteApi function](./code-splitting.md#manually-accessing-route-apis-in-other-files-with-the-getrouteapi-helper) to avoid having to import the \`Route\` configuration to get access to the typed \`useSearch()\` hook.
### Search Params outside of Route Components
You can access your route's validated search params anywhere in your app using the \`useSearch\` hook. By passing the \`from\` id/path of your origin route, you'll get even better type safety:
\`\`\`tsx
// src/routes/shop.products.tsx
export const Route = createFileRoute('/shop/products')({
validateSearch: productSearchSchema,
// ...
})
// Somewhere else...
// src/components/product-list-sidebar.tsx
const routeApi = getRouteApi('/shop/products')
const ProductList = () => {
const routeSearch = routeApi.useSearch()
// OR
const { page, filter, sort } = useSearch({
from: Route.fullPath,
})
return
...
}
\`\`\`
Or, you can loosen up the type-safety and get an optional \`search\` object by passing \`strict: false\`:
\`\`\`tsx
function ProductList() {
const search = useSearch({
strict: false,
})
// {
// page: number | undefined
// filter: string | undefined
// sort: 'newest' | 'oldest' | 'price' | undefined
// }
return
...
}
\`\`\`
## Writing Search Params
Now that you've learned how to read your route's search params, you'll be happy to know that you've already seen the primary APIs to modify and update them. Let's remind ourselves a bit
### \`\`
The best way to update search params is to use the \`search\` prop on the \`\` component.
If the search for the current page shall be updated and the \`from\` prop is specified, the \`to\` prop can be omitted.
Here's an example:
\`\`\`tsx title="src/routes/shop/products.tsx"
export const Route = createFileRoute('/shop/products')({
validateSearch: productSearchSchema,
})
const ProductList = () => {
return (
({ page: prev.page + 1 })}>
Next Page
)
}
\`\`\`
If you want to update the search params in a generic component that is rendered on multiple routes, specifying \`from\` can be challenging.
In this scenario you can set \`to="."\` which will give you access to loosely typed search params.
Here is an example that illustrates this:
\`\`\`tsx
// \`page\` is a search param that is defined in the __root route and hence available on all routes.
const PageSelector = () => {
return (
({ ...prev, page: prev.page + 1 })}>
Next Page
)
}
\`\`\`
If the generic component is only rendered in a specific subtree of the route tree, you can specify that subtree using \`from\`. Here you can omit \`to='.'\` if you want.
\`\`\`tsx
// \`page\` is a search param that is defined in the /posts route and hence available on all of its child routes.
const PageSelector = () => {
return (
({ ...prev, page: prev.page + 1 })}
>
Next Page
)
\`\`\`
### \`useNavigate(), navigate({ search })\`
The \`navigate\` function also accepts a \`search\` option that works the same way as the \`search\` prop on \`\`:
\`\`\`tsx title="src/routes/shop/products.tsx"
export const Route = createFileRoute('/shop/products/$productId')({
validateSearch: productSearchSchema,
})
const ProductList = () => {
const navigate = useNavigate({ from: Route.fullPath })
return (
)
}
\`\`\`
### \`router.navigate({ search })\`
The \`router.navigate\` function works exactly the same way as the \`useNavigate\`/\`navigate\` hook/function above.
### \`\`
The \`\` component works exactly the same way as the \`useNavigate\`/\`navigate\` hook/function above, but accepts its options as props instead of a function argument.
## Transforming search with search middlewares
When link hrefs are built, by default the only thing that matters for the query string part is the \`search\` property of a \`\`.
TanStack Router provides a way to manipulate search params before the href is generated via **search middlewares**.
Search middlewares are functions that transform the search parameters when generating new links for a route or its descendants.
They are also executed upon navigation after search validation to allow manipulation of the query string.
The following example shows how to make sure that for **every** link that is being built, the \`rootValue\` search param is added _if_ it is part of the current search params. If a link specifies \`rootValue\` inside \`search\`, then that value is used for building the link.
\`\`\`tsx
import { z } from 'zod'
import { zodValidator } from '@tanstack/zod-adapter'
const searchSchema = z.object({
rootValue: z.string().optional(),
})
export const Route = createRootRoute({
validateSearch: zodValidator(searchSchema),
search: {
middlewares: [
({ search, next }) => {
const result = next(search)
return {
rootValue: search.rootValue,
...result,
}
},
],
},
})
\`\`\`
Since this specific use case is quite common, TanStack Router provides a generic implementation to retain search params via \`retainSearchParams\`:
# React
\`\`\`tsx
import { z } from 'zod'
import { createFileRoute, retainSearchParams } from '@tanstack/react-router'
import { zodValidator } from '@tanstack/zod-adapter'
const searchSchema = z.object({
rootValue: z.string().optional(),
})
export const Route = createRootRoute({
validateSearch: zodValidator(searchSchema),
search: {
middlewares: [retainSearchParams(['rootValue'])],
},
})
\`\`\`
# Solid
\`\`\`tsx
import { z } from 'zod'
import { createFileRoute, retainSearchParams } from '@tanstack/solid-router'
import { zodValidator } from '@tanstack/zod-adapter'
const searchSchema = z.object({
rootValue: z.string().optional(),
})
export const Route = createRootRoute({
validateSearch: zodValidator(searchSchema),
search: {
middlewares: [retainSearchParams(['rootValue'])],
},
})
\`\`\`
Another common use case is to strip out search params from links if their default value is set. TanStack Router provides a generic implementation for this use case via \`stripSearchParams\`:
# React
\`\`\`tsx
import { z } from 'zod'
import { createFileRoute, stripSearchParams } from '@tanstack/react-router'
import { zodValidator } from '@tanstack/zod-adapter'
const defaultValues = {
one: 'abc',
two: 'xyz',
}
const searchSchema = z.object({
one: z.string().default(defaultValues.one),
two: z.string().default(defaultValues.two),
})
export const Route = createFileRoute('/hello')({
validateSearch: zodValidator(searchSchema),
search: {
// strip default values
middlewares: [stripSearchParams(defaultValues)],
},
})
\`\`\`
# Solid
\`\`\`tsx
import { z } from 'zod'
import { createFileRoute, stripSearchParams } from '@tanstack/solid-router'
import { zodValidator } from '@tanstack/zod-adapter'
const defaultValues = {
one: 'abc',
two: 'xyz',
}
const searchSchema = z.object({
one: z.string().default(defaultValues.one),
two: z.string().default(defaultValues.two),
})
export const Route = createFileRoute('/hello')({
validateSearch: zodValidator(searchSchema),
search: {
// strip default values
middlewares: [stripSearchParams(defaultValues)],
},
})
\`\`\`
Multiple middlewares can be chained. The following example shows how to combine both \`retainSearchParams\` and \`stripSearchParams\`.
# React
\`\`\`tsx
import {
Link,
createFileRoute,
retainSearchParams,
stripSearchParams,
} from '@tanstack/react-router'
import { z } from 'zod'
import { zodValidator } from '@tanstack/zod-adapter'
const defaultValues = ['foo', 'bar']
export const Route = createFileRoute('/search')({
validateSearch: zodValidator(
z.object({
retainMe: z.string().optional(),
arrayWithDefaults: z.string().array().default(defaultValues),
required: z.string(),
}),
),
search: {
middlewares: [
retainSearchParams(['retainMe']),
stripSearchParams({ arrayWithDefaults: defaultValues }),
],
},
})
\`\`\`
# Solid
\`\`\`tsx
import {
Link,
createFileRoute,
retainSearchParams,
stripSearchParams,
} from '@tanstack/solid-router'
import { z } from 'zod'
import { zodValidator } from '@tanstack/zod-adapter'
const defaultValues = ['foo', 'bar']
export const Route = createFileRoute('/search')({
validateSearch: zodValidator(
z.object({
retainMe: z.string().optional(),
arrayWithDefaults: z.string().array().default(defaultValues),
required: z.string(),
}),
),
search: {
middlewares: [
retainSearchParams(['retainMe']),
stripSearchParams({ arrayWithDefaults: defaultValues }),
],
},
})
\`\`\`
# SSR
> [!WARNING]
> While every effort has been made to separate these APIs from changes to Tanstack Start, there are underlying shared implementations internally. Therefore these can be subject to change and should be regarded as experimental until Start reaches stable status.
Server Side Rendering (SSR) is the process of rendering a component on the server and sending the HTML markup to the client. The client then hydrates the markup into a fully interactive component.
There are usually two different flavors of SSR to be considered:
- Non-streaming SSR
- The entire page is rendered on the server and sent to the client in one single HTML request, including the serialized data the application needs to hydrate on the client.
- Streaming SSR
- The critical first paint of the page is rendered on the server and sent to the client in one single HTML request, including the serialized data the application needs to hydrate on the client
- The rest of the page is then streamed to the client as it is rendered on the server.
This guide will explain how to implement both flavors of SSR with TanStack Router!
## Non-Streaming SSR
Non-Streaming server-side rendering is the classic process of rendering the markup for your entire application page on the server and sending the completed HTML markup (and data) to the client. The client then hydrates the markup into a fully interactive application again.
To implement non-streaming SSR with TanStack Router, you will need the following utilities:
# React
- \`RouterClient\` from \`@tanstack/react-router\`
- e.g. \`\`
- Rendering this component in your client entry will render your application and also automatically implement the \`Wrap\` component option on \`Router\`
- And, either:
- \`defaultRenderHandler\` from \`@tanstack/react-router\`
- This will render your application in your server entry and also automatically handle application-level hydration/dehydration and also automatically implement the RouterServer component.
or:
- \`renderRouterToString\` from \`@tanstack/react-router\`
- This differs from defaultRenderHandler in that it allows you to manually specify the \`Wrap\` component option on \`Router\` together with any other providers you may need to wrap it with.
- \`RouterServer\` from \`@tanstack/react-router\`
- This implements the \`Wrap\` component option on \`Router\`
# Solid
- \`RouterClient\` from \`@tanstack/solid-router\`
- e.g. \`\`
- Rendering this component in your client entry will render your application and also automatically implement the \`Wrap\` component option on \`Router\`
- And, either:
- \`defaultRenderHandler\` from \`@tanstack/solid-router\`
- This will render your application in your server entry and also automatically handle application-level hydration/dehydration and also automatically implement the RouterServer component.
or:
- \`renderRouterToString\` from \`@tanstack/solid-router\`
- This differs from defaultRenderHandler in that it allows you to manually specify the \`Wrap\` component option on \`Router\` together with any other providers you may need to wrap it with.
- \`RouterServer\` from \`@tanstack/solid-router\`
- This implements the \`Wrap\` component option on \`Router\`
### Automatic Server History
On the client, Router defaults to using an instance of \`createBrowserHistory\`, which is the preferred type of history to use on the client. On the server, however, you will want to use an instance of \`createMemoryHistory\` instead. This is because \`createBrowserHistory\` uses the \`window\` object, which does not exist on the server. This is handled automatically for you in the RouterServer component.
### Automatic Loader Dehydration/Hydration
Resolved loader data fetched by routes is automatically dehydrated and rehydrated by TanStack Router so long as you complete the standard SSR steps outlined in this guide.
β οΈ If you are using deferred data streaming, you will also need to ensure that you have implemented the [SSR Streaming & Stream Transform](#streaming-ssr) pattern near the end of this guide.
For more information on how to utilize data loading, see the [Data Loading](./data-loading.md) guide.
### Router Creation
Since your router will exist both on the server and the client, it's important that you create your router in a way that is consistent between both of these environments. The easiest way to do this is to expose a \`createRouter\` function in a shared file that can be imported and called by both your server and client entry files.
# React
\`\`\`tsx title='src/router.tsx'
import { createRouter as createTanstackRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'
export function createRouter() {
return createTanstackRouter({ routeTree })
}
declare module '@tanstack/react-router' {
interface Register {
router: ReturnType
}
}
\`\`\`
# Solid
\`\`\`tsx title='src/router.tsx'
import { createRouter as createTanstackRouter } from '@tanstack/solid-router'
import { routeTree } from './routeTree.gen'
export function createRouter() {
return createTanstackRouter({ routeTree })
}
declare module '@tanstack/solid-router' {
interface Register {
router: ReturnType
}
}
\`\`\`
### Rendering the Application on the Server
Now that you have a router instance that has loaded all the critical data for the current URL, you can render your application on the server:
using \`defaultRenderHandler\`
# React
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
defaultRenderHandler,
} from '@tanstack/react-router/ssr/server'
import { createRouter } from './router'
export async function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return await handler(defaultRenderHandler)
}
\`\`\`
# Solid
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
defaultRenderHandler,
} from '@tanstack/solid-router/ssr/server'
import { createRouter } from './router'
export async function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return await handler(defaultRenderHandler)
}
\`\`\`
using \`renderRouterToString\`
# React
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
renderRouterToString,
RouterServer,
} from '@tanstack/react-router/ssr/server'
import { createRouter } from './router'
export function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return handler(({ request, responseHeaders, router }) =>
renderRouterToString({
request,
responseHeaders,
router,
children: ,
}),
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
renderRouterToString,
RouterServer,
} from '@tanstack/react-router/ssr/server'
import { createRouter } from './router'
export function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return handler(({ request, responseHeaders, router }) =>
renderRouterToString({
request,
responseHeaders,
router,
children: ,
}),
)
}
\`\`\`
NOTE: The createRequestHandler method requires a web api standard Request object, while the handler method will return a web api standard Response promise.
Should you be using a server framework like Express that uses its own Request and Response objects you would need to convert from the one to the other. Please have a look at the examples for how such an implementation might look like.
## Rendering the Application on the Client
On the client, things are much simpler.
- Create your router instance
- Render your application using the \`\` component
# React
\`\`\`tsx title="src/entry-client.tsx"
import { hydrateRoot } from 'react-dom/client'
import { RouterClient } from '@tanstack/react-router/ssr/client'
import { createRouter } from './router'
const router = createRouter()
hydrateRoot(document, )
\`\`\`
# Solid
\`\`\`tsx title="src/entry-client.tsx"
import { hydrate } from 'solid-js/web'
import { RouterClient } from '@tanstack/solid-router/ssr/client'
import { createRouter } from './router'
const router = createRouter()
hydrate(() => , document.body)
\`\`\`
With this setup, your application will be rendered on the server and then hydrated on the client!
## Streaming SSR
Streaming SSR is the most modern flavor of SSR and is the process of continuously and incrementally sending HTML markup to the client as it is rendered on the server. This is slightly different from traditional SSR in concept because beyond being able to dehydrate and rehydrate a critical first paint, markup and data with lower priority or slower response times can be streamed to the client after the initial render, but in the same request.
This pattern can be useful for pages that have slow or high-latency data fetching requirements. For example, if you have a page that needs to fetch data from a third-party API, you can stream the critical initial markup and data to the client and then stream the less-critical third-party data to the client as it is resolved.
> [!NOTE]
> This streaming pattern is all automatic as long as you are using either \`defaultStreamHandler\` or \`renderRouterToStream\`.
using \`defaultStreamHandler\`
# React
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
defaultStreamHandler,
} from '@tanstack/react-router/ssr/server'
import { createRouter } from './router'
export async function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return await handler(defaultStreamHandler)
}
\`\`\`
# Solid
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
defaultStreamHandler,
} from '@tanstack/solid-router/ssr/server'
import { createRouter } from './router'
export async function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return await handler(defaultStreamHandler)
}
\`\`\`
using \`renderRouterToStream\`
# React
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
renderRouterToStream,
RouterServer,
} from '@tanstack/react-router/ssr/server'
import { createRouter } from './router'
export function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return handler(({ request, responseHeaders, router }) =>
renderRouterToStream({
request,
responseHeaders,
router,
children: ,
}),
)
}
\`\`\`
# Solid
\`\`\`tsx title="src/entry-server.tsx"
import {
createRequestHandler,
renderRouterToStream,
RouterServer,
} from '@tanstack/solid-router/ssr/server'
import { createRouter } from './router'
export function render({ request }: { request: Request }) {
const handler = createRequestHandler({ request, createRouter })
return handler(({ request, responseHeaders, router }) =>
renderRouterToStream({
request,
responseHeaders,
router,
children: ,
}),
)
}
\`\`\`
## Streaming Dehydration/Hydration
Streaming dehydration/hydration is an advanced pattern that goes beyond markup and allows you to dehydrate and stream any supporting data from the server to the client and rehydrate it on arrival. This is useful for applications that may need to further use/manage the underlying data that was used to render the initial markup on the server.
## Data Serialization
When using SSR, data passed between the server and the client must be serialized before it is sent across network-boundaries. TanStack Router handles this serialization using a very lightweight serializer that supports common data types beyond JSON.stringify/JSON.parse.
Out of the box, the following types are supported:
- \`undefined\`
- \`Date\`
- \`Error\`
- \`FormData\`
If you feel that there are other types that should be supported by default, please open an issue on the TanStack Router repository.
If you are using more complex data types like \`Map\`, \`Set\`, \`BigInt\`, etc, you may need to use a custom serializer to ensure that your type-definitions are accurate and your data is correctly serialized and deserialized. We are currently working on both a more robust serializer and a way to customize the serializer for your application. Open an issue if you are interested in helping out!
# Static Route Data
When creating routes, you can optionally specify a \`staticData\` property in the route's options. This object can literally contain anything you want as long as it's synchronously available when you create your route.
In addition to being able to access this data from the route itself, you can also access it from any match under the \`match.staticData\` property.
## Example
# React
\`\`\`tsx title='src/routes/posts.tsx'
import { createFileRoute } from '@tanstack/react-router'
export const Route = createFileRoute('/posts')({
staticData: {
customData: 'Hello!',
},
})
\`\`\`
You can then access this data anywhere you have access to your routes, including matches that can be mapped back to their routes.
\`\`\`tsx title='src/routes/__root.tsx'
import { createRootRoute } from '@tanstack/react-router'
export const Route = createRootRoute({
component: () => {
const matches = useMatches()
return (
{matches.map((match) => {
return
{match.staticData.customData}
})}
)
},
})
\`\`\`
# Solid
\`\`\`tsx title='src/routes/posts.tsx'
import { createFileRoute } from '@tanstack/solid-router'
export const Route = createFileRoute('/posts')({
staticData: {
customData: 'Hello!',
},
})
\`\`\`
You can then access this data anywhere you have access to your routes, including matches that can be mapped back to their routes.
\`\`\`tsx title='src/routes/__root.tsx'
import { createRootRoute, useMatches } from '@tanstack/solid-router'
import { For } from 'solid-js'
export const Route = createRootRoute({
component: () => {
const matches = useMatches()
return (
{(match) =>
{match.staticData.customData}
}
)
},
})
\`\`\`
## Enforcing Static Data
If you want to enforce that a route has static data, you can use declaration merging to add a type to the route's static option:
# React
\`\`\`tsx
declare module '@tanstack/react-router' {
interface StaticDataRouteOption {
customData: string
}
}
\`\`\`
# Solid
\`\`\`tsx
declare module '@tanstack/solid-router' {
interface StaticDataRouteOption {
customData: string
}
}
\`\`\`
Now, if you try to create a route without the \`customData\` property, you'll get a type error:
\`\`\`tsx
export const Route = createFileRoute('/posts')({
staticData: {
// Property 'customData' is missing in type '{ customData: number; }' but required in type 'StaticDataRouteOption'.ts(2741)
},
})
\`\`\`
## Optional Static Data
If you want to make static data optional, simply add a \`?\` to the property:
# React
\`\`\`tsx
declare module '@tanstack/react-router' {
interface StaticDataRouteOption {
customData?: string
}
}
\`\`\`
# Solid
\`\`\`tsx
declare module '@tanstack/solid-router' {
interface StaticDataRouteOption {
customData?: string
}
}
\`\`\`
As long as there are any required properties on the \`StaticDataRouteOption\`, you'll be required to pass in an object.
## Common Patterns
### Controlling Layout Visibility
Use staticData to control which routes show or hide layout elements:
\`\`\`tsx title='src/routes/admin/route.tsx'
export const Route = createFileRoute('/admin')({
staticData: { showNavbar: false },
component: AdminLayout,
})
\`\`\`
\`\`\`tsx
// routes/__root.tsx
function RootComponent() {
const showNavbar = useMatches({
select: (matches) =>
!matches.some((m) => m.staticData?.showNavbar === false),
})
return showNavbar ? (
) : (
)
}
\`\`\`
### Route Titles for Breadcrumbs
# React
\`\`\`tsx title='src/routes/posts/$postId.tsx'
export const Route = createFileRoute('/posts/$postId')({
staticData: {
getTitle: () => 'Post Details',
},
})
\`\`\`
\`\`\`tsx title='src/components/Breadcrumbs.tsx'
function Breadcrumbs() {
const matches = useMatches()
return (
)
}
\`\`\`
# Solid
\`\`\`tsx title='src/routes/posts/$postId.tsx'
export const Route = createFileRoute('/posts/$postId')({
staticData: {
getTitle: () => 'Post Details',
},
})
\`\`\`
\`\`\`tsx title='src/components/Breadcrumbs.tsx'
import { useMatches } from '@tanstack/solid-router'
import { For } from 'solid-js'
function Breadcrumbs() {
const matches = useMatches()
return (
)
}
\`\`\`
### When to Use staticData vs Context
| staticData | context |
| -------------------------------------- | ------------------------------- |
| Synchronous, defined at route creation | Can be async (via \`beforeLoad\`) |
| Available before loading starts | Can depend on params/search |
| Same for all instances of a route | Passed down to child routes |
Use staticData for static route metadata. Use context for dynamic data or auth state that varies per request.
# Type Safety
TanStack Router is built to be as type-safe as possible within the limits of the TypeScript compiler and runtime. This means that it's not only written in TypeScript, but that it also **fully infers the types it's provided and tenaciously pipes them through the entire routing experience**.
Ultimately, this means that you write **less types as a developer** and have **more confidence in your code** as it evolves.
## Route Definitions
### File-based Routing
Routes are hierarchical, and so are their definitions. If you're using file-based routing, much of the type-safety is already taken care of for you.
### Code-based Routing
If you're using the \`Route\` class directly, you'll need to be aware of how to ensure your routes are typed properly using the \`Route\`'s \`getParentRoute\` option. This is because child routes need to be aware of **all** of their parent routes types. Without this, those precious search params you parsed out of your _layout_ and _pathless layout_ routes, 3 levels up, would be lost to the JS void.
So, don't forget to pass the parent route to your child routes!
\`\`\`tsx
const parentRoute = createRoute({
getParentRoute: () => parentRoute,
})
\`\`\`
## Exported Hooks, Components, and Utilities
For the types of your router to work with top-level exports like \`Link\`, \`useNavigate\`, \`useParams\`, etc. they must permeate the TypeScript module boundary and be registered right into the library. To do this, we use declaration merging on the exported \`Register\` interface.
# React
\`\`\`ts
const router = createRouter({
// ...
})
declare module '@tanstack/react-router' {
interface Register {
router: typeof router
}
}
\`\`\`
# Solid
\`\`\`ts
const router = createRouter({
// ...
})
declare module '@tanstack/solid-router' {
interface Register {
router: typeof router
}
}
\`\`\`
By registering your router with the module, you can now use the exported hooks, components, and utilities with your router's exact types.
## Fixing the Component Context Problem
Component context is a wonderful tool in React and other frameworks for providing dependencies to components. However, if that context is changing types as it moves throughout your component hierarchy, it becomes impossible for TypeScript to know how to infer those changes. To get around this, context-based hooks and components require that you give them a hint on how and where they are being used.
\`\`\`tsx
export const Route = createFileRoute('/posts')({
component: PostsComponent,
})
function PostsComponent() {
// Each route has type-safe versions of most of the built-in hooks from TanStack Router
const params = Route.useParams()
const search = Route.useSearch()
// Some hooks require context from the *entire* router, not just the current route. To achieve type-safety here,
// we must pass the \`from\` param to tell the hook our relative position in the route hierarchy.
const navigate = useNavigate({ from: Route.fullPath })
// ... etc
}
\`\`\`
Every hook and component that requires a context hint will have a \`from\` param where you can pass the ID or path of the route you are rendering within.
> π§ Quick tip: If your component is code-split, you can use the [getRouteApi function](./code-splitting.md#manually-accessing-route-apis-in-other-files-with-the-getrouteapi-helper) to avoid having to pass in the \`Route.fullPath\` to get access to the typed \`useParams()\` and \`useSearch()\` hooks.
### What if I don't know the route? What if it's a shared component?
The \`from\` property is optional, which means if you don't pass it, you'll get the router's best guess on what types will be available. Usually, that means you'll get a union of all of the types of all of the routes in the router.
### What if I pass the wrong \`from\` path?
It's technically possible to pass a \`from\` that satisfies TypeScript, but may not match the actual route you are rendering within at runtime. In this case, each hook and component that supports \`from\` will detect if your expectations don't match the actual route you are rendering within, and will throw a runtime error.
### What if I don't know the route, or it's a shared component, and I can't pass \`from\`?
If you are rendering a component that is shared across multiple routes, or you are rendering a component that is not within a route, you can pass \`strict: false\` instead of a \`from\` option. This will not only silence the runtime error, but will also give you relaxed, but accurate types for the potential hook you are calling. A good example of this is calling \`useSearch\` from a shared component:
\`\`\`tsx
function MyComponent() {
const search = useSearch({ strict: false })
}
\`\`\`
In this case, the \`search\` variable will be typed as a union of all possible search params from all routes in the router.
## Router Context
Router context is so extremely useful as it's the ultimate hierarchical dependency injection. You can supply context to the router and to each and every route it renders. As you build up this context, TanStack Router will merge it down with the hierarchy of routes, so that each route has access to the context of all of its parents.
The \`createRootRouteWithContext\` factory creates a new router with the instantiated type, which then creates a requirement for you to fulfill the same type contract to your router, and will also ensure that your context is properly typed throughout the entire route tree.
\`\`\`tsx
const rootRoute = createRootRouteWithContext<{ whateverYouWant: true }>()({
component: App,
})
const routeTree = rootRoute.addChildren([
// ... all child routes will have access to \`whateverYouWant\` in their context
])
const router = createRouter({
routeTree,
context: {
// This will be required to be passed now
whateverYouWant: true,
},
})
\`\`\`
## Performance Recommendations
As your application scales, TypeScript check times will naturally increase. There are a few things to keep in mind when your application scales to keep your TS check times down.
### Only infer types you need
A great pattern with client side data caches (TanStack Query, etc.) is to prefetch data. For example with TanStack Query you might have a route which calls \`queryClient.ensureQueryData\` in a \`loader\`.
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId/deep')({
loader: ({ context: { queryClient }, params: { postId } }) =>
queryClient.ensureQueryData(postQueryOptions(postId)),
component: PostDeepComponent,
})
function PostDeepComponent() {
const params = Route.useParams()
const data = useSuspenseQuery(postQueryOptions(params.postId))
return <>
}
\`\`\`
This may look fine and for small route trees and you may not notice any TS performance issues. However in this case TS has to infer the loader's return type, despite it never being used in your route. If the loader data is a complex type with many routes that prefetch in this manner, it can slow down editor performance. In this case, the change is quite simple and let typescript infer Promise.
\`\`\`tsx
export const Route = createFileRoute('/posts/$postId/deep')({
loader: async ({ context: { queryClient }, params: { postId } }) => {
await queryClient.ensureQueryData(postQueryOptions(postId))
},
component: PostDeepComponent,
})
function PostDeepComponent() {
const params = Route.useParams()
const data = useSuspenseQuery(postQueryOptions(params.postId))
return <>
}
\`\`\`
This way the loader data is never inferred and it moves the inference out of the route tree to the first time you use \`useSuspenseQuery\`.
### Narrow to relevant routes as much as you possibly can
Consider the following usage of \`Link\`
\`\`\`tsx
\`\`\`
**These examples are bad for TS performance**. That's because \`search\` resolves to a union of all \`search\` params for all routes and TS has to check whatever you pass to the \`search\` prop against this potentially big union. As your application grows, this check time will increase linearly to number of routes and search params. We have done our best to optimize for this case (TypeScript will typically do this work once and cache it) but the initial check against this large union is expensive. This also applies to \`params\` and other API's such as \`useSearch\`, \`useParams\`, \`useNavigate\` etc.
Instead you should try to narrow to relevant routes with \`from\` or \`to\`.
\`\`\`tsx
\`\`\`
Remember you can always pass a union to \`to\` or \`from\` to narrow the routes you're interested in.
\`\`\`tsx
const from: '/posts/$postId/deep' | '/posts/' = '/posts/'
\`\`\`
You can also pass branches to \`from\` to only resolve \`search\` or \`params\` to be from any descendants of that branch:
\`\`\`tsx
const from = '/posts'
\`\`\`
\`/posts\` could be a branch with many descendants which share the same \`search\` or \`params\`
### Consider using the object syntax of \`addChildren\`
It's typical of routes to have \`params\` \`search\`, \`loaders\` or \`context\` that can even reference external dependencies which are also heavy on TS inference. For such applications, using objects for creating the route tree can be more performant than tuples.
\`createChildren\` also can accept an object. For large route trees with complex routes and external libraries, objects can be much faster for TS to type check as opposed to large tuples. The performance gains depend on your project, what external dependencies you have and how the types for those libraries are written
\`\`\`tsx
const routeTree = rootRoute.addChildren({
postsRoute: postsRoute.addChildren({ postRoute, postsIndexRoute }),
indexRoute,
})
\`\`\`
Note this syntax is more verbose but has better TS performance. With file based routing, the route tree is generated for you so a verbose route tree is not a concern
### Avoid internal types without narrowing
It's common you might want to re-use types exposed. For example you might be tempted to use \`LinkProps\` like so
\`\`\`tsx
const props: LinkProps = {
to: '/posts/',
}
return (
)
\`\`\`
**This is VERY bad for TS Performance**. The problem here is \`LinkProps\` has no type arguments and is therefore an extremely large type. It includes \`search\` which is a union of all \`search\` params, it contains \`params\` which is a union of all \`params\`. When merging this object with \`Link\` it will do a structural comparison of this huge type.
Instead you can use \`as const satisfies\` to infer a precise type and not \`LinkProps\` directly to avoid the huge check
\`\`\`tsx
const props = {
to: '/posts/',
} as const satisfies LinkProps
return (
)
\`\`\`
As \`props\` is not of type \`LinkProps\` and therefore this check is cheaper because the type is much more precise. You can also improve type checking further by narrowing \`LinkProps\`
\`\`\`tsx
const props = {
to: '/posts/',
} as const satisfies LinkProps
return (
)
\`\`\`
This is even faster as we're checking against the narrowed \`LinkProps\` type.
You can also use this to narrow the type of \`LinkProps\` to a specific type to be used as a prop or parameter to a function
\`\`\`tsx
export const myLinkProps = [
{
to: '/posts',
},
{
to: '/posts/$postId',
params: { postId: 'postId' },
},
] as const satisfies ReadonlyArray
export type MyLinkProps = (typeof myLinkProps)[number]
const MyComponent = (props: { linkProps: MyLinkProps }) => {
return
}
\`\`\`
This is faster than using \`LinkProps\` directly in a component because \`MyLinkProps\` is a much more precise type
Another solution is not to use \`LinkProps\` and to provide inversion of control to render a \`Link\` component narrowed to a specific route. Render props are a good method of inverting control to the user of a component
\`\`\`tsx
export interface MyComponentProps {
readonly renderLink: () => React.ReactNode
}
const MyComponent = (props: MyComponentProps) => {
return
{props.renderLink()}
}
const Page = () => {
return } />
}
\`\`\`
This particular example is very fast as we've inverted control of where we're navigating to the user of the component. The \`Link\` is narrowed to the exact route
we want to navigate to
# Type Utilities
Most types exposed by TanStack Router are internal, subject to breaking changes and not always easy to use. That is why TanStack Router has a subset of exposed types focused on ease of use with the intension to be used externally. These types provide the same type safe experience from TanStack Router's runtime concepts on the type level, with flexibility of where to provide type checking
## Type checking Link options with \`ValidateLinkOptions\`
\`ValidateLinkOptions\` type checks object literal types to ensure they conform to \`Link\` options at inference sites. For example, you may have a generic \`HeadingLink\` component which accepts a \`title\` prop along with \`linkOptions\`, the idea being this component can be re-used for any navigation.
# React
\`\`\`tsx
export interface HeaderLinkProps<
TRouter extends RegisteredRouter = RegisteredRouter,
TOptions = unknown,
> {
title: string
linkOptions: ValidateLinkOptions
}
export function HeadingLink(
props: HeaderLinkProps,
): React.ReactNode
export function HeadingLink(props: HeaderLinkProps): React.ReactNode {
return (
<>
)
}
\`\`\`
A more permissive overload of \`HeadingLink\` is used to avoid type assertions you would otherwise have to do with the generic signature. Using a looser signature without type parameters is an easy way to avoid type assertions in the implementation of \`HeadingLink\`
All type parameters for utilities are optional but for the best TypeScript performance \`TRouter\` should always be specified for the public facing signature. And \`TOptions\` should always be used at inference sites like \`HeadingLink\` to infer the \`linkOptions\` to correctly narrow \`params\` and \`search\`
The result of this is that \`linkOptions\` in the following is completely type-safe
\`\`\`tsx
\`\`\`
## Type checking an array of Link options with \`ValidateLinkOptionsArray\`
All navigation type utilities have an array variant. \`ValidateLinkOptionsArray\` enables type checking of an array of \`Link\` options. For example, you might have a generic \`Menu\` component where each item is a \`Link\`.
# React
\`\`\`tsx
export interface MenuProps<
TRouter extends RegisteredRouter = RegisteredRouter,
TItems extends ReadonlyArray = ReadonlyArray,
> {
items: ValidateLinkOptionsArray
}
export function Menu<
TRouter extends RegisteredRouter = RegisteredRouter,
TItems extends ReadonlyArray,
>(props: MenuProps): React.ReactNode
export function Menu(props: MenuProps): React.ReactNode {
return (
)
}
\`\`\`
This of course allows the following \`items\` prop to be completely type-safe
\`\`\`tsx
\`\`\`
It is also possible to fix \`from\` for each \`Link\` options in the array. This would allow all \`Menu\` items to navigate relative to \`from\`. Additional type checking of \`from\` can be provided by the \`ValidateFromPath\` utility
# React
\`\`\`ts
export interface MenuProps<
TRouter extends RegisteredRouter = RegisteredRouter,
TItems extends ReadonlyArray = ReadonlyArray,
TFrom extends string = string,
> {
from: ValidateFromPath
items: ValidateLinkOptionsArray
}
export function Menu<
TRouter extends RegisteredRouter = RegisteredRouter,
TItems extends ReadonlyArray,
TFrom extends string = string,
>(props: MenuProps): React.ReactNode
export function Menu(props: MenuProps): React.ReactNode {
return (
)
}
\`\`\`
\`ValidateLinkOptionsArray\` allows you to fix \`from\` by providing an extra type parameter. The result is a type safe array of \`Link\` options providing navigation relative to \`from\`
\`\`\`tsx
\`\`\`
## Type checking redirect options with \`ValidateRedirectOptions\`
\`ValidateRedirectOptions\` type checks object literal types to ensure they conform to redirect options at inference sites. For example, you may need a generic \`fetchOrRedirect\` function which accepts a \`url\` along with \`redirectOptions\`, the idea being this function will redirect when the \`fetch\` fails.
\`\`\`tsx
export async function fetchOrRedirect<
TRouter extends RegisteredRouter = RegisteredRouter,
TOptions,
>(
url: string,
redirectOptions: ValidateRedirectOptions,
): Promise
export async function fetchOrRedirect(
url: string,
redirectOptions: ValidateRedirectOptions,
): Promise {
const response = await fetch(url)
if (!response.ok && response.status === 401) {
throw redirect(redirectOptions)
}
return await response.json()
}
\`\`\`
The result is that \`redirectOptions\` passed to \`fetchOrRedirect\` is completely type-safe
\`\`\`tsx
fetchOrRedirect('http://example.com/', { to: '/login' })
\`\`\`
## Type checking navigate options with \`ValidateNavigateOptions\`
\`ValidateNavigateOptions\` type checks object literal types to ensure they conform to navigate options at inference sites. For example, you may want to write a custom hook to enable/disable navigation.
# React
\`\`\`tsx
export interface UseConditionalNavigateResult {
enable: () => void
disable: () => void
navigate: () => void
}
export function useConditionalNavigate<
TRouter extends RegisteredRouter = RegisteredRouter,
TOptions,
>(
navigateOptions: ValidateNavigateOptions,
): UseConditionalNavigateResult
export function useConditionalNavigate(
navigateOptions: ValidateNavigateOptions,
): UseConditionalNavigateResult {
const [enabled, setEnabled] = useState(false)
const navigate = useNavigate()
return {
enable: () => setEnabled(true),
disable: () => setEnabled(false),
navigate: () => {
if (enabled) {
navigate(navigateOptions)
}
},
}
}
\`\`\`
# Solid
\`\`\`tsx
import { createSignal } from 'solid-js'
export interface UseConditionalNavigateResult {
enable: () => void
disable: () => void
navigate: () => void
}
export function useConditionalNavigate<
TRouter extends RegisteredRouter = RegisteredRouter,
TOptions = unknown,
>(
navigateOptions: ValidateNavigateOptions,
): UseConditionalNavigateResult
export function useConditionalNavigate(
navigateOptions: ValidateNavigateOptions,
): UseConditionalNavigateResult {
const [enabled, setEnabled] = createSignal(false)
const navigate = useNavigate()
return {
enable: () => setEnabled(true),
disable: () => setEnabled(false),
navigate: () => {
if (enabled()) {
navigate(navigateOptions)
}
},
}
}
\`\`\`
The result of this is that \`navigateOptions\` passed to \`useConditionalNavigate\` is completely type-safe and we can enable/disable navigation based on react state
\`\`\`tsx
const { enable, disable, navigate } = useConditionalNavigate({
to: '/posts/$postId',
params: { postId: 'postId' },
})
\`\`\`
# URL Rewrites
URL rewrites allow you to transform URLs bidirectionally between what the browser displays and what the router interprets internally. This powerful feature enables patterns like locale prefixes, subdomain routing, legacy URL migration, and multi-tenant applications without duplicating routes or complicating your route tree.
## When to Use URL Rewrites
URL rewrites are useful when you need to:
- **i18n locale prefixes**: Display \`/en/about\` in the browser but route to \`/about\` internally
- **Subdomain routing**: Route \`admin.example.com/users\` to \`/admin/users\` internally
- **Legacy URL migration**: Support old URLs like \`/old-path\` that map to new routes
- **Multi-tenant applications**: Route \`tenant1.example.com\` to tenant-specific routes
- **Custom URL schemes**: Transform any URL pattern to match your route structure
## How URL Rewrites Work
URL rewrites operate in two directions:
1. **Input rewrite**: Transforms the URL **from the browser** before the router interprets it
2. **Output rewrite**: Transforms the URL **from the router** before it's written to the browser
\`\`\`
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Browser URL Bar β
β /en/about?q=test β
βββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββ
β
βΌ input rewrite
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Router Internal URL β
β /about?q=test β
β β
β (matches routes, runs loaders) β
βββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββ
β
βΌ output rewrite
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Browser URL Bar β
β /en/about?q=test β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
\`\`\`
The router exposes two href properties on the location object:
- \`location.href\` - The internal URL (after input rewrite)
- \`location.publicHref\` - The external URL displayed in the browser (after output rewrite)
## Basic Usage
Configure rewrites when creating your router:
\`\`\`tsx
import { createRouter } from '@tanstack/react-router'
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => {
// Transform browser URL β router internal URL
// Return the modified URL, a new URL, or undefined to skip
return url
},
output: ({ url }) => {
// Transform router internal URL β browser URL
// Return the modified URL, a new URL, or undefined to skip
return url
},
},
})
\`\`\`
The \`input\` and \`output\` functions receive a \`URL\` object and can:
- Mutate and return the same \`url\` object
- Return a new \`URL\` instance
- Return a full href string (will be parsed into a URL)
- Return \`undefined\` to skip the rewrite
## Common Patterns
### Pattern 1: i18n Locale Prefix
Strip locale prefixes on input and add them back on output:
\`\`\`tsx
const locales = ['en', 'fr', 'es', 'de']
const defaultLocale = 'en'
// Get current locale (from cookie, localStorage, or detection)
function getLocale() {
return localStorage.getItem('locale') || defaultLocale
}
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => {
// Check if pathname starts with a locale prefix
const segments = url.pathname.split('/').filter(Boolean)
const firstSegment = segments[0]
if (firstSegment && locales.includes(firstSegment)) {
// Strip the locale prefix: /en/about β /about
url.pathname = '/' + segments.slice(1).join('/') || '/'
}
return url
},
output: ({ url }) => {
const locale = getLocale()
// Add locale prefix: /about β /en/about
if (locale !== defaultLocale || true) {
// Always prefix, or conditionally skip default locale
url.pathname = \`/\${locale}\${url.pathname === '/' ? '' : url.pathname}\`
}
return url
},
},
})
\`\`\`
For production i18n, consider using a library like Paraglide that provides \`localizeUrl\` and \`deLocalizeUrl\` functions. See the [Internationalization guide](./internationalization-i18n.md) for integration details.
### Pattern 2: Subdomain to Path Routing
Route subdomain requests to path-based routes:
\`\`\`tsx
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => {
const subdomain = url.hostname.split('.')[0]
// admin.example.com/users β /admin/users
if (subdomain === 'admin') {
url.pathname = '/admin' + url.pathname
}
// api.example.com/v1/users β /api/v1/users
else if (subdomain === 'api') {
url.pathname = '/api' + url.pathname
}
return url
},
output: ({ url }) => {
// Reverse the transformation for link generation
if (url.pathname.startsWith('/admin')) {
url.hostname = 'admin.example.com'
url.pathname = url.pathname.replace(/^\\/admin/, '') || '/'
} else if (url.pathname.startsWith('/api')) {
url.hostname = 'api.example.com'
url.pathname = url.pathname.replace(/^\\/api/, '') || '/'
}
return url
},
},
})
\`\`\`
### Pattern 3: Legacy URL Migration
Support old URLs while maintaining new route structure:
\`\`\`tsx
const legacyPaths: Record = {
'/old-about': '/about',
'/old-contact': '/contact',
'/blog-posts': '/blog',
'/user-profile': '/account/profile',
}
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => {
const newPath = legacyPaths[url.pathname]
if (newPath) {
url.pathname = newPath
}
return url
},
// No output rewrite needed - new URLs will be used going forward
},
})
\`\`\`
### Pattern 4: Multi-tenant Routing
Route tenant-specific domains to a unified route structure:
\`\`\`tsx
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => {
// Extract tenant from subdomain: acme.app.com β acme
const parts = url.hostname.split('.')
if (parts.length >= 3) {
const tenant = parts[0]
// Inject tenant into the path: /dashboard β /tenant/acme/dashboard
url.pathname = \`/tenant/\${tenant}\${url.pathname}\`
}
return url
},
output: ({ url }) => {
// Extract tenant from path and move to subdomain
const match = url.pathname.match(/^\\/tenant\\/([^/]+)(.*)$/)
if (match) {
const [, tenant, rest] = match
url.hostname = \`\${tenant}.app.com\`
url.pathname = rest || '/'
}
return url
},
},
})
\`\`\`
### Pattern 5: Search Parameter Transformation
Transform search parameters during rewrites:
\`\`\`tsx
const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => {
// Convert legacy search param format
// ?filter_status=active β ?status=active
const filterStatus = url.searchParams.get('filter_status')
if (filterStatus) {
url.searchParams.delete('filter_status')
url.searchParams.set('status', filterStatus)
}
return url
},
output: ({ url }) => {
// Optionally transform back for external display
return url
},
},
})
\`\`\`
## Composing Multiple Rewrites
When you need multiple independent rewrite transformations, use \`composeRewrites\` to combine them:
\`\`\`tsx
import { composeRewrites } from '@tanstack/react-router'
const localeRewrite = {
input: ({ url }) => {
// Strip locale prefix
const match = url.pathname.match(/^\\/(en|fr|es)(\\/.*)$/)
if (match) {
url.pathname = match[2] || '/'
}
return url
},
output: ({ url }) => {
// Add locale prefix
url.pathname = \`/en\${url.pathname === '/' ? '' : url.pathname}\`
return url
},
}
const legacyRewrite = {
input: ({ url }) => {
if (url.pathname === '/old-page') {
url.pathname = '/new-page'
}
return url
},
}
const router = createRouter({
routeTree,
rewrite: composeRewrites([localeRewrite, legacyRewrite]),
})
\`\`\`
**Order of operations:**
- **Input rewrites**: Execute in order (first to last)
- **Output rewrites**: Execute in reverse order (last to first)
This ensures that composed rewrites "unwrap" correctly. In the example above:
- Input: locale strips \`/en\`, then legacy redirects \`/old-page\`
- Output: legacy runs first (no-op), then locale adds \`/en\` back
## Interaction with Basepath
When you configure a \`basepath\`, the router internally implements it as a rewrite. If you also provide a custom \`rewrite\`, they are automatically composed together:
\`\`\`tsx
const router = createRouter({
routeTree,
basepath: '/app',
rewrite: {
input: ({ url }) => {
// This runs AFTER basepath is stripped
// Browser: /app/en/about β After basepath: /en/about β Your rewrite: /about
return url
},
output: ({ url }) => {
// This runs BEFORE basepath is added
// Your rewrite: /about β After your rewrite: /en/about β Basepath adds: /app/en/about
return url
},
},
})
\`\`\`
The composition order ensures:
1. **Input**: Basepath stripped first, then your rewrite runs
2. **Output**: Your rewrite runs first, then basepath added
## Working with Links and Navigation
### Link Component
The \`\` component automatically applies output rewrites when generating \`href\` attributes:
\`\`\`tsx
// With locale rewrite configured (adds /en prefix)
About
// Renders: About
\`\`\`
### Programmatic Navigation
Programmatic navigation via \`navigate()\` or \`router.navigate()\` also respects rewrites:
\`\`\`tsx
const navigate = useNavigate()
// Navigates to /about internally, displays /en/about in browser
navigate({ to: '/about' })
\`\`\`
### Hard Links for Cross-Origin Rewrites
When an output rewrite changes the origin (hostname), the \`\` component automatically renders a standard anchor tag instead of using client-side navigation:
\`\`\`tsx
// Rewrite that changes hostname for /admin paths
const router = createRouter({
routeTree,
rewrite: {
output: ({ url }) => {
if (url.pathname.startsWith('/admin')) {
url.hostname = 'admin.example.com'
url.pathname = url.pathname.replace(/^\\/admin/, '') || '/'
}
return url
},
},
})
// This link will be a hard navigation (full page load)
Admin Dashboard
// Renders: Admin Dashboard
\`\`\`
## The publicHref Property
The router's location object includes a \`publicHref\` property that contains the external URL (after output rewrite):
\`\`\`tsx
function MyComponent() {
const location = useLocation()
// Internal URL used for routing
console.log(location.href) // "/about"
// External URL shown in browser
console.log(location.publicHref) // "/en/about"
return (
{/* Use publicHref for sharing, canonical URLs, etc. */}
)
}
\`\`\`
Use \`publicHref\` when you need the actual browser URL for:
- Social sharing
- Canonical URLs
- Analytics tracking
- Copying links to clipboard
## Server-side Considerations
URL rewrites apply on both client and server. When using TanStack Start:
### Server Middleware
Rewrites are applied when parsing incoming requests:
\`\`\`tsx
// router.tsx
export const router = createRouter({
routeTree,
rewrite: {
input: ({ url }) => deLocalizeUrl(url),
output: ({ url }) => localizeUrl(url),
},
})
\`\`\`
The server handler will use the same rewrite configuration to parse incoming URLs and generate responses with the correct external URLs.
### SSR Hydration
The router ensures that the server-rendered HTML and client hydration use consistent URLs. The \`publicHref\` is serialized during SSR so the client can hydrate with the correct external URL.
## API Reference
### \`rewrite\` option
- Type: [\`LocationRewrite\`](#locationrewrite-type)
- Optional
- Configures bidirectional URL transformation between browser and router.
### LocationRewrite type
\`\`\`tsx
type LocationRewrite = {
/**
* Transform the URL before the router interprets it.
* Called when reading from browser history.
*/
input?: LocationRewriteFunction
/**
* Transform the URL before it's written to browser history.
* Called when generating links and committing navigation.
*/
output?: LocationRewriteFunction
}
\`\`\`
### LocationRewriteFunction type
\`\`\`tsx
type LocationRewriteFunction = (opts: { url: URL }) => undefined | string | URL
\`\`\`
**Parameters:**
- \`url\`: A \`URL\` object representing the current URL
**Returns:**
- \`URL\`: The transformed URL object (can be the same mutated object or a new instance)
- \`string\`: A full href string that will be parsed into a URL
- \`undefined\`: Skip the rewrite, use the original URL
### composeRewrites function
\`\`\`tsx
import { composeRewrites } from '@tanstack/react-router'
function composeRewrites(rewrites: Array): LocationRewrite
\`\`\`
Combines multiple rewrite pairs into a single rewrite. Input rewrites execute in order, output rewrites execute in reverse order.
**Example:**
\`\`\`tsx
const composedRewrite = composeRewrites([
{ input: rewrite1Input, output: rewrite1Output },
{ input: rewrite2Input, output: rewrite2Output },
])
// Input execution order: rewrite1Input β rewrite2Input
// Output execution order: rewrite2Output β rewrite1Output
\`\`\`
## Examples
Complete working examples are available in the TanStack Router repository:
- [React + Paraglide (Client-side i18n)](https://github.com/TanStack/router/tree/main/examples/react/i18n-paraglide)
- [React + TanStack Start + Paraglide (SSR i18n)](https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide)
- [Solid + Paraglide (Client-side i18n)](https://github.com/TanStack/router/tree/main/examples/solid/i18n-paraglide)
- [Solid + TanStack Start + Paraglide (SSR i18n)](https://github.com/TanStack/router/tree/main/examples/solid/start-i18n-paraglide)
`;