NavigationCurrentEntryChangeEvent

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 NavigationCurrentEntryChangeEvent interface of the Navigation API is the event object for the currententrychange event, which fires when the Navigation.currentEntry has changed.

This event will fire for same-document navigations (e.g. back() or traverseTo()), replacements (i.e. a navigate() call with history set to replace), or other calls that change the entry's state (e.g. updateCurrentEntry(), or the History API's History.replaceState()).

This event fires after the navigation is committed, meaning that the visible URL has changed and the NavigationHistoryEntry update has occurred. It is useful for migrating from usage of older API features like the hashchange or popstate events.

Event NavigationCurrentEntryChangeEvent

Constructor

Creates a new NavigationCurrentEntryChangeEvent object instance.

Instance properties

Inherits properties from its parent, Event.

from Read only

Returns the NavigationHistoryEntry that was navigated from.

Returns the type of the navigation that resulted in the change.

Examples

Navigation data reporting:

js
navigation.addEventListener("currententrychange", () => {
  const data = navigation.currentEntry.getState();
  submitAnalyticsData(data.analytics);
});

Setting up a per-entry event:

js
navigation.addEventListener("currententrychange", () => {
  navigation.currentEntry.addEventListener("dispose", genericDisposeHandler);
});

Specifications

Specification
HTML Standard
# the-navigationcurrententrychangeevent-interface

Browser compatibility

BCD tables only load in the browser

See also