mirror of
https://github.com/TanStack/router.git
synced 2026-11-18 19:34:24 +00:00
* docs: reference docs * docs: guides * docs: top-level * docs: missed the route-trees * docs: fixing routing-concepts
1.5 KiB
1.5 KiB
| id | title |
|---|---|
| rootRouteWithContextFunction | rootRouteWithContext function |
Caution
This function is deprecated and will be removed in the next major version of TanStack Router. Please use the
createRootRouteWithContextfunction instead.
The rootRouteWithContext function is a helper function that can be used to create a root route instance that requires a context type to be fulfilled when the router is created.
rootRouteWithContext generics
The rootRouteWithContext function accepts a single generic argument:
TRouterContext generic
- Type:
TRouterContext - Optional, but recommended.
- The context type that will be required to be fulfilled when the router is created
rootRouteWithContext returns
- A factory function that can be used to create a new
createRootRouteinstance. - It accepts a single argument, the same as the
createRootRoutefunction.
Examples
import { rootRouteWithContext, createRouter } from '@tanstack/react-router'
import { QueryClient } from '@tanstack/react-query'
interface MyRouterContext {
queryClient: QueryClient
}
const rootRoute = rootRouteWithContext<MyRouterContext>()({
component: () => <Outlet />,
// ... root route options
})
const routeTree = rootRoute.addChildren([
// ... other routes
])
const queryClient = new QueryClient()
const router = createRouter({
routeTree,
context: {
queryClient,
},
})