NavigationDestination: getState() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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 Standard # the-navigationdestination-interface:dom-navigationdestination-getstate-2 |
Browser compatibility
BCD tables only load in the browser
See also
- Modern client-side routing: the Navigation API
- Navigation API explainer
- Domenic Denicola's Navigation API live demo
- Methods that allow state to be updated —
Navigation.navigate()
,Navigation.reload()
, andNavigation.updateCurrentEntry()