NavigationDestination: getState() method
Baseline
2026
Newly available
Since January 2026, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
The getState() method of the
NavigationDestination interface returns a clone of the developer-supplied state associated with the destination NavigationHistoryEntry, or navigation operation (e.g., navigate()) as appropriate.
Syntax
js
getState()
Parameters
None.
Return value
A value representing the state. This can be any type.
If no state is defined, it returns undefined.
Exceptions
None.
Examples
js
navigation.addEventListener("navigate", (event) => {
console.log(event.destination.getState());
});
Specifications
| Specification |
|---|
| HTML # the-navigationdestination-interface:dom-navigationdestination-getstate-2 |
Browser compatibility
See also
- Modern client-side routing: the Navigation API
- Navigation API explainer
- Methods that allow state to be updated —
Navigation.navigate(),Navigation.reload(), andNavigation.updateCurrentEntry()