NavigateEvent: userInitiated property

{{APIRef("Navigation API")}}

The userInitiated read-only property of the {{domxref("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

Getting userInitiated for an event

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Modern client-side routing: the Navigation API
• Navigation API explainer