Function: getNavigableRoutes()

Documentation / @xmachines/play-router / getNavigableRoutes

function getNavigableRoutes(tree, stateId): RouteNode[];

Defined in: query.ts:20

Get all routes navigable from given state

Returns child routes of the specified state. Future enhancement will include sibling routes reachable via transitions.

Parameters

Parameter	Type	Description
tree	RouteTree	Route tree from extractMachineRoutes()
stateId	string	Current state ID

Returns

RouteNode[]

Array of route nodes reachable from state

Example

const tree = extractMachineRoutes(machine);
const routes = getNavigableRoutes(tree, "dashboard");
// [{ id: 'overview', path: '/overview', ... }, { id: 'settings', ... }]