Interface: RouteNavigateEvent
API / @xmachines/play-tanstack-react-router / RouteNavigateEvent
Defined in: play-tanstack-react-router/src/types.ts:24
The event that the bridge sends to the actor when the browser navigates.
A browser navigation sends this event to the actor. A click on a link, the BACK or FORWARD button, and a URL that the user types each cause a navigation. The guards of the actor then decide if the business logic permits the navigation.
Invariant: Passive Infrastructure. The router makes a request, and the actor decides the validity.
Example
actor.send({ type: "route.navigate", path: "/dashboard" });Deprecated
Superseded by PlayRouteEvent from @xmachines/play-router. Will be removed in the next major.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
path | readonly | string | The target route path. It can hold a parameter, for example /posts/123 | play-tanstack-react-router/src/types.ts:28 |
type | readonly | "route.navigate" | The event type discriminant. It follows the XState event pattern | play-tanstack-react-router/src/types.ts:26 |