Navigation: navigate-Ereignis

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Das navigate-Ereignis der Navigation-Schnittstelle wird ausgelöst, wenn jede Art von Navigation initiiert wird. Es bietet die Möglichkeit, die Navigation bei Bedarf abzufangen.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("navigate", (event) => {});

onnavigate = (event) => {};

Ereignistyp

Ein NavigateEvent. Erbt von Event.

Event NavigateEvent

Beispiele

Eine Navigation mit intercept() behandeln

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);
      },
    });
  }
});

Hinweis: Bevor die Navigation API verfügbar war, mussten Sie, um etwas Ähnliches zu erreichen, alle Klick-Ereignisse auf Links überwachen, event.preventDefault() ausführen, den entsprechenden History.pushState()-Aufruf durchführen und dann die Seitenansicht basierend auf der neuen URL einrichten. Dies hätte jedoch nicht alle Navigationsarten erfasst - nur vom Benutzer initiierte Link-Klicks.

Scrollen mit scroll() behandeln

In diesem Beispiel des Abfangens einer Navigation beginnt die handler()-Funktion damit, einige Artikelinhalte abzurufen und darzustellen. Anschließend werden einige sekundäre Inhalte abgerufen und dargestellt. Es ist sinnvoll, die Seite so bald wie möglich zum Hauptartikelinhalt zu scrollen, damit der Benutzer damit interagieren kann, anstatt zu warten, bis auch die sekundären Inhalte dargestellt sind. Um dies zu erreichen, haben wir einen scroll()-Aufruf zwischen den beiden eingefügt.

js
navigation.addEventListener("navigate", (event) => {
  if (shouldNotIntercept(navigateEvent)) {
    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);
      },
    });
  }
});

Spezifikationen

Specification
HTML Standard
# event-navigate

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch