Salesforce Docs Portal

PageReference

An LWR router receives navigation events as page references. Page references are a JSON-format specification of a location. You pass a PageReference object to the router via the navigate API.

Syntax

interface PageReference {
  type: string;
  attributes: { [key: string]: string | null };
  state: { [key: string]: string | null };
}

Properties

Property Type Required/Optional Description
type string Required An identifier that's a user-defined expression.
attributes array Required An array of user-defined key-value pairs. If there are no attribute values, set this property to null.
state array Required An array of user-defined key-value pairs. If there are no attribute values, set this property to null.

Example

// URI
https://www.somewhere.com/animals/abc?view=compact&dark-mode

// page reference
{
    "type": "animal_page",
    "attributes": {
        "animalId": "abc"
    },
    "state": {
        "view": "compact",
        "dark-mode": ""
    }
}

See Also