Back to Content

Navigation: navigatesuccess event

files/en-us/web/api/navigation/navigatesuccess_event/index.md

latest1.4 KB
Original Source

{{APIRef("Navigation API")}}

The navigatesuccess event of the {{domxref("Navigation")}} interface is fired when a successful navigation has finished.

In the case of an intercepted navigation, this would occur after any promises returned by your {{domxref("NavigateEvent.intercept", "intercept()")}} handler are fulfilled. The {{domxref("NavigationTransition.finished")}} promise will also fulfill at the same time.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

js-nolint
addEventListener("navigatesuccess", (event) => { })

onnavigatesuccess = (event) => { }

Event type

A generic {{domxref("Event")}}.

Examples

You might deal with a successful navigation by hiding a previously displayed progress indicator, like this:

js
navigation.addEventListener("navigatesuccess", (event) => {
  loadingIndicator.hidden = true;
});

Or you might show an error message on failure:

js
navigation.addEventListener("navigateerror", (event) => {
  loadingIndicator.hidden = true; // also hide indicator
  showMessage(`Failed to load page: ${event.message}`);
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also