A route handler receives a RouteInstance when a new client-side navigation event occurs. RouteInstance contains location information passed to RouteHandler.update. The route handler uses the RouteInstance to determine which view to show.
Syntax
interface RouteInstance {
id: string; // RouteDefinition.id
pageReference: PageReference;
label: string;
}
Properties
| Property | Type | Required/Optional | Description |
|---|---|---|---|
id |
String | Required | The unique identifier for the RouteDefinition. |
pageReference |
PageReference object |
Required | The PageReference object for the navigation event. |
Example
{
id: '1',
pageReference: {
type: 'animal',
attributes: { pageName: 'animal' },
state: {},
},
},
See Also