Interface: RouteNode
API / @xmachines/play-router / index / RouteNode
Defined in: packages/play-router/src/types.ts:179
A node of the route tree. It represents one route
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
children | RouteNode[] | The child routes | packages/play-router/src/types.ts:204 |
fullPath | string | The complete absolute path from the root, for example "/dashboard/overview". Always use fullPath for a match of a browser URL and for the construction of a route map. createRouteMapFromTree and createRouteMap both use this field. | packages/play-router/src/types.ts:193 |
id | string | The unique identifier, which is the state ID | packages/play-router/src/types.ts:181 |
metadata | RouteMetadata | The original meta.route metadata | packages/play-router/src/types.ts:208 |
parent | RouteNode | null | The parent route. It is null for the root | packages/play-router/src/types.ts:206 |
path | string | The raw segment of the route path, as meta.route declares it. It is relative, for example "overview", or absolute, for example "/dashboard". Never use it for a match of a URL: use fullPath for that. | packages/play-router/src/types.ts:187 |
pattern? | string | The route pattern with its parameters, for example /profile/:userId, when path holds a parameter | packages/play-router/src/types.ts:195 |
routable | boolean | It tells you if this state has a route, which means that it has a meta.route field. A state with a meta.route field can receive a play.route event | packages/play-router/src/types.ts:202 |
stateId | string | The XState state ID of this route | packages/play-router/src/types.ts:197 |