createRootRoute function | TanStack Router React Docs

The createRootRoute function returns a new root route instance. A root route instance can then be used to create a route-tree.

createRootRoute options

The options that will be used to configure the root route instance.

Type:

tsx

Omit<
  RouteOptions,
  | 'path'
  | 'id'
  | 'getParentRoute'
  | 'caseSensitive'
  | 'parseParams'
  | 'stringifyParams'
>

RouteOptions
Optional

createRootRoute returns

A new Route instance.

Examples

tsx

import { createRootRoute, createRouter, Outlet } from '@tanstack/react-router'

const rootRoute = createRootRoute({
  component: () => <Outlet />,
  // ... root route options
})

const routeTree = rootRoute.addChildren([
  // ... other routes
])

const router = createRouter({
  routeTree,
})