Package-level declarations

Types

Link copied to clipboard
external interface ActiveLinkOptionProps
Link copied to clipboard
Link copied to clipboard
external interface ErrorComponentProps : Props
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface NotFoundRouteProps : Props
Link copied to clipboard
external interface RootRoute : BaseRootRoute
Link copied to clipboard
Link copied to clipboard
external interface Route : BaseRoute
Link copied to clipboard
Link copied to clipboard
typealias RouteId = String
Link copied to clipboard
Link copied to clipboard
external class Router
Link copied to clipboard
external interface RouterOptions : RouterOptions<RootRoute>
Link copied to clipboard
external interface RouterProviderProps : Props
Link copied to clipboard
external interface UpdatableRouteOptions
Link copied to clipboard
external interface UseRouterOptions

Properties

Link copied to clipboard
external val Link: FC<LinkComponentProps>

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard

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

Link copied to clipboard
external fun createRoute(options: RouteOptions): Route

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

Link copied to clipboard
external fun createRouter(options: RouterOptions): Router

Creates a new Router instance for React.

Link copied to clipboard
Link copied to clipboard
external fun useRouter(options: UseRouterOptions = definedExternally): Router

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