NavigationHistoryEntry: key Eigenschaft

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.

Die key-Eigenschaft des NavigationHistoryEntry-Interfaces ist eine schreibgeschützte Eigenschaft, die den key des Verlaufseintrags zurückgibt, oder einen leeren String, wenn das aktuelle Dokument nicht vollständig aktiv ist. Dies ist ein einzigartiger, vom Benutzeragenten generierter Wert, der den Slot des Verlaufseintrags in der Eintragsliste repräsentiert. Es wird verwendet, um diesen bestimmten Slot über Navigation.traverseTo() zu navigieren. Der key wird von anderen Einträgen verwendet, die den Eintrag in der Liste ersetzen (das heißt, wenn der NavigateEvent.navigationType replace ist).

Dies unterscheidet sich von der id eines Verlaufseintrags. Die id ist ein einzigartiger, vom Benutzeragenten generierter Wert, der immer einen bestimmten Verlaufseintrag anstelle seines Platzes in der Eintragsliste darstellt. Dies ist nützlich, um ihn mit einer externen Ressource wie einem Speicher-Cache zu korrelieren.

Wert

Ein String, der den key des NavigationHistoryEntry repräsentiert.

Beispiele

Grundlegende Verwendung

js
const current = navigation.currentEntry;
console.log(current.key);

Einrichten einer Home-Schaltfläche

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-navigationhistoryentry-key-dev

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch