W3cubDocs

/Web APIs

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

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

navigation.addEventListener("navigate", (event) => {
  console.log(event.destination.getState());
});

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android WebView on iOS
getState 102 102 No 88 No 102 No 70 No 19.0 102 No

See also

© 2005–2025 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/NavigationDestination/getState