NavigationCurrentEntryChangeEvent: NavigationCurrentEntryChangeEvent() constructor

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() constructor creates a new NavigationCurrentEntryChangeEvent object.

Syntax

js
new NavigationCurrentEntryChangeEvent(type, init)

Parameters

type

A string representing the type of event. In the case of NavigationCurrentEntryChangeEvent this is always event.

init

An object containing the following properties:

destination

A NavigationHistoryEntry object representing the location being navigated to.

The type of the navigation that resulted in the change. Possible values are push, reload, replace, and traverse. Defaults to null.

Examples

A developer would not use this constructor manually. A new NavigationCurrentEntryChangeEvent object is constructed when a handler is invoked as a result of the currententrychange event firing.

js
navigation.addEventListener("currententrychange", (event) => {
  console.log(event.navigationType);
});

Specifications

Specification
HTML Standard
# the-navigationcurrententrychangeevent-interface

Browser compatibility

BCD tables only load in the browser

See also