mirror of
https://github.com/TanStack/router.git
synced 2026-11-16 19:38:07 +00:00
1.7 KiB
1.7 KiB
| id | title |
|---|---|
| RouterProvider | RouterProvider |
Use the RouterProvider component to connect and provide a ReactRouter to your application:
import { RouterProvider, ReactRouter } from '@tanstack/react-router'
const router = new new ReactRouter)
function App() {
return <RouterProvider router={router}>...</RouterProvider>
}
Options
router: Router- Required
- the
ReactRouterinstance to provide
history?: BrowserHistory | MemoryHistory | HashHistory- Optional
stringifySearch?: SearchSerializer- Optional
parseSearch?: SearchParser- Optional
filterRoutes?: FilterRoutesFn- Optional
defaultPreload?: false | 'intent'- Optional
defaultPreloadMaxAge?: number- Optional
defaultPreloadGcMaxAge?: number- Optional
defaultPreloadDelay?: number- Optional
defaultComponent?: GetFrameworkGeneric<'Component'>- Optional
defaultErrorComponent?: GetFrameworkGeneric<'ErrorComponent'>- Optional
defaultPendingComponent?: GetFrameworkGeneric<'Component'>- Optional
defaultLoaderMaxAge?: number- Optional
defaultLoaderGcMaxAge?: number- Optional
caseSensitive?: boolean- Optional
routeConfig?: TRouteConfig- Optional
basepath?: string- Optional
useServerData?: boolean- Optional
Router?: (router: Router<any, any, any>) => void- Optional
createRoute?: (opts: { route: AnyRoute, router: Router<any, any, any> }) => void- Optional
context?: TRouterContext- Optional
loadComponent?: (component: GetFrameworkGeneric<'Component'>) => Promise<GetFrameworkGeneric<'Component'>- Optional