Navigation: navigate() Methode

Syntax

navigate(url)
navigate(url, options)

Parameter

url

Die Ziel-URL, zu der navigiert werden soll. Beachten Sie, dass beim Aufrufen von navigate() auf dem navigation-Objekt eines anderen Fensters die URL relativ zur URL des Ziel-Fensters aufgelöst wird, nicht relativ zur URL des aufrufenden Fensters. Dies entspricht dem Verhalten der History API, jedoch nicht dem Verhalten der Location API. Beachten Sie auch, dass javascript: URLs aus Sicherheitsgründen nicht erlaubt sind.

options Optional

Ein Optionsobjekt mit den folgenden Eigenschaften:

state Optional

Vom Entwickler definierte Informationen, die im zugehörigen NavigationHistoryEntry gespeichert werden, sobald die Navigation abgeschlossen ist, und über getState() abrufbar sind. Dies kann jeder Datentyp sein. Sie könnten beispielsweise eine Seitenaufrufzahl für Analysezwecke speichern oder Details zum UI-Zustand, sodass die Ansicht genau so angezeigt werden kann, wie der Benutzer sie zuletzt verlassen hat. Alle im state gespeicherten Daten müssen structured-cloneable sein.

info Optional

Vom Entwickler definierte Informationen, die an das navigate Ereignis weitergegeben werden, verfügbar in NavigateEvent.info. Dies kann jeder Datentyp sein. Sie könnten beispielsweise wollen, dass neu navigierter Inhalt mit einer anderen Animation angezeigt wird, je nachdem, wie darauf navigiert wurde (nach links wischen, nach rechts wischen oder zur Startseite gehen). Eine Zeichenkette, die angibt, welche Animation verwendet werden soll, könnte als info übergeben werden.

history Optional

Ein enumerierter Wert, der das Verlaufverhalten dieser Navigation festlegt. Die verfügbaren Werte sind:

• auto: Der Standardwert; wird normalerweise eine push Navigation ausführen, aber eine replace Navigation unter besonderen Umständen ausführen (siehe die Beschreibung des NotSupportedError unten).
• push: Fügt einen neuen NavigationHistoryEntry zur Liste der Einträge hinzu oder schlägt unter besonderen Umständen fehl (siehe die Beschreibung des NotSupportedError unten).
• replace: Ersetzt den aktuellen NavigationHistoryEntry.

Rückgabewert

Ein Objekt mit den folgenden Eigenschaften:

committed

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

finished

Ein Promise, der erfüllt wird, wenn alle von der intercept() Handler zurückgegebenen Versprechen erfüllt sind. Dies entspricht dem Erfüllen des Versprechens NavigationTransition.finished, wenn das navigatesuccess Ereignis ausgelöst wird.

Jedes dieser Versprechen wird abgelehnt, wenn die Navigation aus irgendeinem Grund fehlgeschlagen ist.

Ausnahmen

DataCloneError DOMException

Wird ausgelöst, wenn der state Parameter Werte enthält, die nicht structured-cloneable sind.

InvalidStateError DOMException

Wird ausgelöst, wenn das Dokument derzeit nicht aktiv ist.

SyntaxError DOMException

Wird ausgelöst, wenn der url Parameter keine gültige URL ist.

NotSupportedError DOMException

Wird ausgelöst, wenn:

• Die history Option auf push gesetzt ist und der Browser derzeit das initiale about:blank Dokument anzeigt.
• Das Schema der url javascript ist.

Beispiele

Einrichten des Home-Buttons

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

Ein intelligenter Zurück-Button

Ein von der Seite bereitgestellter "Zurück"-Button kann Sie zurückführen, selbst nach einem Reload, indem frühere Verlaufseinträge überprüft werden:

backButtonEl.addEventListener("click", () => {
  if (
    navigation.entries()[navigation.currentEntry.index - 1]?.url ===
    "/product-listing"
  ) {
    navigation.back();
  } else {
    // If the user arrived here in some other way
    // e.g. by typing the URL directly:
    navigation.navigate("/product-listing", { history: "replace" });
  }
});

Verwendung von info und state

async function navigateHandler() {
  await navigation.navigate(url, {
    info: { animation: "swipe-right" },
    state: { infoPaneOpen: true },
  }).finished;

  // Update application state
  // …
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Moderne clientseitige Routenverwaltung: die Navigation API
• Navigation API Erklärung