RouteInstance

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

1interface RouteInstance {
2  id: string; // RouteDefinition.id
3  pageReference: PageReference;
4  label: string;
5}

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

1{
2    id: '1',
3    pageReference: {
4        type: 'animal',
5        attributes: { pageName: 'animal' },
6        state: {},
7    },
8},

See Also

Route Handler Modules

Developer Preview Feature

Feature is available as a developer preview. Feature is not generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Do not implement functionality developed with these commands or tools.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!