NavigationDestination: index property

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 index read-only property of the NavigationDestination interface returns the index value of the destination NavigationHistoryEntry if the NavigateEvent.navigationType is traverse, or -1 otherwise.

Value

A number representing the index of the destination NavigationHistoryEntry, or -1.

Examples

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

Specifications

Specification
HTML Standard
# the-navigationdestination-interface:dom-navigationdestination-index-2

Browser compatibility

BCD tables only load in the browser

See also