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
# the-navigationdestination-interface:dom-navigationdestination-getstate-2

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getState
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.

See also