createRoute

external fun createRoute(options: RouteOptions): Route(source)

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

Use this to define a route that will be composed into a route tree (typically via a parent route's addChildren). If you're using file-based routing, prefer createFileRoute.

Online Documentation

Return

A Route instance to be attached to the route tree.

Parameters

options

Route options (path, component, loader, context, etc.).