RouteApi class

The RouteApi class provides type-safe version of common hooks like useParams, useSearch, useRouteContext, useNavigate, useLoaderData, and useLoaderDeps that are pre-bound to a specific route ID and corresponding registered route types.

The RouteApi constructor accepts a single argument: the options that will be used to configure the RouteApi instance.

• Type: string
• Required
• The route ID to which the RouteApi instance will be bound

• An instance of the RouteApi that is pre-bound to the route ID that it was called with.

import { RouteApi } from '@tanstack/react-router'

const routeApi = new RouteApi({ id: '/posts' })

export function PostsPage() {
  const posts = routeApi.useLoaderData()
  // ...
}