Package-level declarations

A strongly-typed anchor component for declarative navigation. Handles path, search, hash and state updates with optional route preloading and active-state styling.

Render the next child match in the route tree. Typically used inside a route component to render nested routes.

Top-level component that renders the active route matches and provides the router to the React tree via context.

Creates a root Route instance used to build your route tree.

Creates a non-root Route instance for code-based routing.

Creates a new Router instance for React.

API Docs

Read the current location from the URL with optional selection. Useful for subscribing to just the pieces of location you care about.

The useMatches hook returns the router's complete presented array of RouteMatch objects regardless of its caller's position in the component tree. The array can include still-loading descendants or matches below a pending/error/not-found render boundary.

Create a matcher function for testing locations against route definitions.

Imperative navigation hook.

Access the current TanStack Router instance from React context. Must be used within a RouterProvider.