NavigateEvent.userInitiated

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

The userInitiated read-only property of the NavigateEvent interface returns true if the navigation was initiated by the user (e.g. by clicking a link, submitting a form, or pressing the browser's "Back"/"Forward" buttons), or false otherwise.

Note: The table found at Appendix: types of navigations shows which navigation types are user-initiated.

Value

A boolean value—true if the navigation is user-initiated, false if not.

Examples

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

Specifications

Specification
Navigation API
# dom-navigateevent-userinitiated

Browser compatibility

BCD tables only load in the browser

See also