ContextQMD
Back to Content

NavigateEvent

files/en-us/web/api/navigateevent/index.md

latest6.7 KB
Original Source

{{APIRef("Navigation API")}}

The NavigateEvent interface of the {{domxref("Navigation API", "Navigation API", "", "nocode")}} is the event object for the {{domxref("Navigation/navigate_event", "navigate")}} event, which fires when any type of navigation is initiated (this includes usage of {{domxref("History API", "History API", "", "nocode")}} features like {{domxref("History.go()")}}). NavigateEvent provides access to information about that navigation, and allows developers to intercept and control the navigation handling.

{{InheritanceDiagram}}

Constructor

  • {{domxref("NavigateEvent.NavigateEvent", "NavigateEvent()")}}
    • : Creates a new NavigateEvent object instance.

Instance properties

Inherits properties from its parent, {{DOMxRef("Event")}}.

  • {{domxref("NavigateEvent.canIntercept", "canIntercept")}} {{ReadOnlyInline}}
    • : Returns true if the navigation can be intercepted, or false otherwise (e.g., you can't intercept a cross-origin navigation).
  • {{domxref("NavigateEvent.destination", "destination")}} {{ReadOnlyInline}}
    • : Returns a {{domxref("NavigationDestination")}} object representing the destination being navigated to.
  • {{domxref("NavigateEvent.downloadRequest", "downloadRequest")}} {{ReadOnlyInline}}
    • : Returns the filename of the file requested for download, in the case of a download navigation (e.g., an {{htmlelement("a")}} or {{htmlelement("area")}} element with a download attribute), or null otherwise.
  • {{domxref("NavigateEvent.formData", "formData")}} {{ReadOnlyInline}}
    • : Returns the {{domxref("FormData")}} object representing the submitted data in the case of a POST form submission, or null otherwise.
  • {{domxref("NavigateEvent.hashChange", "hashChange")}} {{ReadOnlyInline}}
    • : Returns true if the navigation is a fragment navigation (i.e., to a fragment identifier in the same document), or false otherwise.
  • {{domxref("NavigateEvent.hasUAVisualTransition", "hasUAVisualTransition")}} {{ReadOnlyInline}}
    • : Returns true if the user agent performed a visual transition for this navigation before dispatching this event, or false otherwise.
  • {{domxref("NavigateEvent.info", "info")}} {{ReadOnlyInline}}
    • : Returns the info data value passed by the initiating navigation operation (e.g., {{domxref("Navigation.back()")}}, or {{domxref("Navigation.navigate()")}}), or undefined if no info data was passed.
  • {{domxref("NavigateEvent.navigationType", "navigationType")}} {{ReadOnlyInline}}
    • : Returns the type of the navigation — push, reload, replace, or traverse.
  • {{domxref("NavigateEvent.signal", "signal")}} {{ReadOnlyInline}}
    • : Returns an {{domxref("AbortSignal")}}, which will become aborted if the navigation is cancelled (e.g., by the user pressing the browser's "Stop" button, or another navigation starting and thus cancelling the ongoing one).
  • {{domxref("NavigateEvent.sourceElement", "sourceElement")}} {{ReadOnlyInline}}
    • : When the navigation was initiated by an element (for example clicking a link), returns an {{domxref("Element")}} object representing the initiating element.
  • {{domxref("NavigateEvent.userInitiated", "userInitiated")}} {{ReadOnlyInline}}
    • : 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.

Instance methods

Inherits methods from its parent, {{DOMxRef("Event")}}.

  • {{domxref("NavigateEvent.intercept", "intercept()")}}
    • : Intercepts this navigation, turning it into a same-document navigation to the {{domxref("NavigationDestination.url", "destination")}} URL. It can accept handler functions that define what the navigation handling behavior should be, plus focusReset and scroll options to enable or disable the browser's default focus and scrolling behavior as desired.
  • {{domxref("NavigateEvent.scroll", "scroll()")}}
    • : Can be called to manually trigger the browser-driven scrolling behavior that occurs in response to the navigation, if you want it to happen before the navigation handling has completed.

Examples

Handling a navigation using intercept()

js
navigation.addEventListener("navigate", (event) => {
  // Exit early if this navigation shouldn't be intercepted,
  // e.g. if the navigation is cross-origin, or a download request
  if (shouldNotIntercept(event)) return;

  const url = new URL(event.destination.url);

  if (url.pathname.startsWith("/articles/")) {
    event.intercept({
      async handler() {
        // The URL has already changed, so show a placeholder while
        // fetching the new content, such as a spinner or loading page
        renderArticlePagePlaceholder();

        // Fetch the new content and display when ready
        const articleContent = await getArticleContent(url.pathname);
        renderArticlePage(articleContent);
      },
    });
  }
});

[!NOTE] Before the Navigation API was available, to do something similar you'd have to listen for all click events on links, run e.preventDefault(), perform the appropriate {{domxref("History.pushState()")}} call, then set up the page view based on the new URL. And this wouldn't handle all navigations — only user-initiated link clicks.

Handling scrolling using scroll()

In this example of intercepting a navigation, the handler() function starts by fetching and rendering some article content, but then fetches and renders some secondary content afterwards. It makes sense to scroll the page to the main article content as soon as it is available so the user can interact with it, rather than waiting until the secondary content is also rendered. To achieve this, we have added a {{domxref("NavigateEvent.scroll", "scroll()")}} call between the two.

js
navigation.addEventListener("navigate", (event) => {
  if (shouldNotIntercept(event)) return;
  const url = new URL(event.destination.url);

  if (url.pathname.startsWith("/articles/")) {
    event.intercept({
      async handler() {
        const articleContent = await getArticleContent(url.pathname);
        renderArticlePage(articleContent);

        event.scroll();

        const secondaryContent = await getSecondaryContent(url.pathname);
        addSecondaryContent(secondaryContent);
      },
    });
  }
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also