Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

RouterProvider.md

63 lines1.7 KB

Use the RouterProvider component to connect and provide a createReactRouter to your application:

import { RouterProvider, createReactRouter } from '@tanstack/react-router'

const router = new createReactRouter()

function App() {
  return <RouterProvider router={router}>...</RouterProvider>
}

Options

  • router: Router
    • Required
    • the createReactRouter instance 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
  • createRouter?: (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