ContextQMD
Back to Router

createRouter function

docs/router/api/router/createRouterFunction.md

1.166.7665 B
Original Source

The createRouter function accepts a RouterOptions object and creates a new Router instance.

createRouter options

  • Type: RouterOptions
  • Required
  • The options that will be used to configure the router instance.

createRouter returns

Examples

tsx
import { createRouter, RouterProvider } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'

const router = createRouter({
  routeTree,
  defaultPreload: 'intent',
})

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