Navigation: traverseTo()-Methode

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, bevor Sie diese produktiv verwenden.

Die traverseTo()-Methode des Navigation-Interfaces navigiert zu dem durch den gegebenen key identifizierten NavigationHistoryEntry.

Syntax

js
traverseTo(key)
traverseTo(key, options)

Parameter

key

Der key des NavigationHistoryEntry, zu dem navigiert werden soll.

options Optional

Ein Optionen-Objekt, das folgende Eigenschaften enthält:

info Optional

Entwicklerdefinierte Informationen, die an das navigate-Event weitergegeben werden, verfügbar in NavigateEvent.info. Dies kann jeden Datentyp umfassen. Sie könnten beispielsweise wünschen, neu navigierte Inhalte mit einer anderen Animation anzuzeigen, je nachdem, wie darauf zugegriffen wurde (nach links wischen, nach rechts wischen oder zur Startseite). Ein String, der angibt, welche Animation verwendet werden soll, könnte als info übergeben werden.

Rückgabewert

Ein Objekt mit den folgenden Eigenschaften:

committed

Ein Promise, welches erfüllt wird, wenn die sichtbare URL geändert wurde und ein neuer NavigationHistoryEntry erstellt wurde.

finished

Ein Promise, welches erfüllt wird, wenn alle von dem intercept()-Handler zurückgegebenen Promises erfüllt sind. Dies entspricht der Erfüllung des NavigationTransition.finished-Promise, wenn das navigatesuccess-Event ausgelöst wird.

Eines dieser Promises wird abgelehnt, wenn die Navigation aus irgendeinem Grund fehlgeschlagen ist.

Ausnahmen

InvalidStateError DOMException

Ausgelöst, wenn der Navigation.currentEntry's NavigationHistoryEntry.index-Wert -1 ist, was bedeutet, dass das aktuelle Document noch nicht aktiv ist, oder wenn die Navigationshistorienliste keinen NavigationHistoryEntry mit dem angegebenen key enthält, oder wenn das aktuelle Document entladen wird.

Beispiele

Home-Button einrichten

js
function initHomeBtn() {
  // Get the key of the first loaded entry
  // so the user can always go back to this view.
  const { key } = navigation.currentEntry;
  backToHomeButton.onclick = () => {
    navigation.traverseTo(key);
  };
}
// Intercept navigate events, such as link clicks, and
// replace them with single-page navigations
navigation.addEventListener("navigate", (event) => {
  event.intercept({
    async handler() {
      // Navigate to a different view,
      // but the "home" button will always work.
    },
  });
});

Spezifikationen

Specification
HTML Standard
# dom-navigation-traverseto-dev

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch