NavigationDestination.key

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The key read-only property of the NavigationDestination interface returns the key value of the destination NavigationHistoryEntry if the NavigateEvent.navigationType is traverse, or null otherwise.

The key is a unique, UA-generated value that represents the history entry's slot in the history entries list, used to navigate to this place in the history via Navigation.traverseTo(). It will be reused by other entries that replace the entry in the list (i.e. if the NavigateEvent.navigationType is replace).

Value

A string representing the key of the destination NavigationHistoryEntry, or null.

Examples

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

Specifications

Specification
Navigation API
# dom-navigationdestination-key

Browser compatibility

BCD tables only load in the browser

See also