Interface: RouteNavigateEvent
Documentation / @xmachines/play-tanstack-react-router / RouteNavigateEvent
Defined in: play-tanstack-react-router/src/types.ts:21
Event sent to actor when browser navigates.
Browser navigation (user clicks link, back/forward button, direct URL entry) sends this event to the actor. The actor’s guards determine if navigation is allowed based on business logic.
Invariant: Passive Infrastructure - Router suggests, actor decides validity.
Example
actor.send({ type: "route.navigate", path: "/dashboard" });Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
path | readonly | string | Target route path (may include parameters, e.g., /posts/123) | play-tanstack-react-router/src/types.ts:25 |
type | readonly | "route.navigate" | Event type discriminant (extends XState event pattern) | play-tanstack-react-router/src/types.ts:23 |