CKTIS / JavaScript
Sichtbarkeit des Dokuments: `Document.hidden` und `visibilitychange`
Lies die aktuelle Sichtbarkeit des Dokuments mit `document.hidden` aus und reagiere mit `visibilitychange` auf Änderungen, ohne den Zustand regelmäßig abzufragen.
Version: Current web platform; runtime support varies
Syntax
document.hidden
document.visibilityState
document.addEventListener("visibilitychange", listener)
document.removeEventListener("visibilitychange", listener)document.hidden ist eine schreibgeschützte boolesche Eigenschaft. Sie ist true, wenn document.visibilityState den Wert "hidden" hat, und false bei "visible". Ein Tab im Hintergrund oder ein minimiertes Fenster sind typische Gründe dafür, dass ein Dokument als verborgen gilt. Der Zustand sagt nichts darüber aus, ob die Seite den Fokus hat, ein bestimmtes Element sichtbar ist oder jemand auf die Seite schaut.
Der Browser löst visibilitychange auf document aus, nachdem sich der Zustand in eine der beiden Richtungen geändert hat. Das Ereignis ist ein einfaches Event, das aufsteigt und nicht abgebrochen werden kann. Es enthält den neuen Zustand nicht: Lies die Eigenschaft im Listener aus. Die Registrierung ruft den Listener nicht sofort auf; lies den Anfangszustand separat aus. Zum Entfernen übergib dieselbe Funktion an removeEventListener.
Du kannst zum Beispiel unnötige Aktualisierungen der Oberfläche aussetzen, solange das Dokument verborgen ist, und sie fortsetzen, sobald es wieder sichtbar ist. "hidden" heißt nicht, dass die Seite geschlossen wurde. Verlass dich auch nicht darauf, dass der Browser deinem Code Zeit gibt, laufende Arbeit abzuschließen. Dies ist eine Web-API und kein Teil von ECMAScript. Ihre Verfügbarkeit hängt von der Laufzeitumgebung ab.
Beispiele
const stopVisibilityLog = (() => {
const hasDocument = typeof document !== "undefined";
const page = hasDocument ? document : new EventTarget();
let simulatedHidden = false;
if (!hasDocument) {
// Node.js fixture: simulate visibility without a browser document.
Object.defineProperty(page, "hidden", { get: () => simulatedHidden });
}
const logVisibility = () => {
console.log(page.hidden ? "hidden" : "visible");
};
page.addEventListener("visibilitychange", logVisibility);
logVisibility();
const stop = () => {
page.removeEventListener("visibilitychange", logVisibility);
};
if (!hasDocument) {
const changeVisibility = (hidden) => {
simulatedHidden = hidden;
page.dispatchEvent(new Event("visibilitychange", { bubbles: true }));
};
changeVisibility(true);
changeVisibility(false);
stop();
changeVisibility(true); // No log after removing the listener.
}
return stop;
})();Ergebnis
visible hidden visible
Führe den Code einmal in der Browserkonsole einer sichtbaren Seite aus. Wechsle zu einem anderen Tab und wieder zurück. Die gezeigte Ausgabe setzt nach dem ersten Auslesen genau diese beiden Änderungen voraus. Beende die Protokollierung mit `stopVisibilityLog()`. Unter Node.js simuliert das Beispiel Sichtbarkeitsänderungen, statt ein Browserdokument zu verwenden.
Zugehörige Lektionen
- JavaScript · Lektion 27 · Mittlere Stufe · Version: 3
- JavaScript · Lektion 29 · Mittlere Stufe · Version: 3
- JavaScript · Lektion 31 · Mittlere Stufe · Version: 3