CKTIS / JavaScript
Die Ereignisse DOMContentLoaded, pagehide und scroll
Unterscheide zwischen einem bereiten DOM, dem Verlassen der Seite und dem Scrollen. Wähle das passende Ziel für jeden Listener und berücksichtige den Back-Forward-Cache.
Version: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
document.addEventListener("DOMContentLoaded", onReady, { once: true });
window.addEventListener("pagehide", onPageHide);
document.addEventListener("scroll", onDocumentScroll);
scrollBox.addEventListener("scroll", onElementScroll);Diese Browserereignisse beantworten drei verschiedene Fragen: Ist das DOM bereit für die Initialisierung? Verlässt der Browser das Dokument? Hat sich die Scrollposition geändert? Sie gehören zur Webplattform, nicht zu ECMAScript. Außerhalb eines Browsers sind document und window nicht vorauszusetzen.
DOMContentLoaded wird auf document ausgelöst, nachdem das HTML vollständig geparst wurde, klassische Skripte mit defer ausgeführt wurden und der Browser die Auswertung der für das Ende des Parsens vorgesehenen Modulskripte ohne async angestoßen hat. Das Ereignis wartet nicht auf den Abschluss der asynchronen Modulauswertung: Ein await auf oberster Ebene in einer Abhängigkeit kann die Ausführung des Modulrumpfs des importierenden Moduls bis nach dem Ereignis verzögern. Anders als load wartet das Ereignis nicht auf Bilder, eingebettete Frames oder async-Skripte. Ein Stylesheet kann es indirekt verzögern, wenn es ein Skript blockiert.
Wenn der Initialisierungscode spät laufen könnte, prüfe document.readyState. Bei "loading" registrierst du einen einmaligen Listener für DOMContentLoaded; sonst initialisierst du sofort. "interactive" bedeutet, dass das Parsen abgeschlossen ist, nicht dass das Ereignis schon ausgelöst wurde oder andere zurückgestellte Skripte fertig sind.
Registriere pagehide auf window, wenn du auf das Verlassen des Dokuments reagieren willst, nicht auf einen bloßen Tabwechsel. Bei diesem PageTransitionEvent zeigt event.persisted === true, dass eine Wiederherstellung aus dem Back-Forward-Cache (bfcache) möglich, aber nicht garantiert ist. false bedeutet, dass dieses Dokument nicht zur Wiederverwendung aufbewahrt wird. Setze die Arbeit nach dem Wiederherstellen mit pageshow und persisted === true fort, nicht mit DOMContentLoaded. pagehide kann ausbleiben, etwa wenn das Betriebssystem einen mobilen Browser beendet. Speichere wichtige Daten fortlaufend; erkenne das Ausblenden des Tabs mit visibilitychange und einer Prüfung auf "hidden".
Höre für das Scrollen der Seite auf scroll bei document und lies window.scrollY aus. Höre für einen Scrollcontainer direkt auf dem Element und lies dessen scrollTop aus. Auch per Code ausgelöstes Scrollen kann das Ereignis auslösen; es markiert nicht das Ende des Scrollens. Halte den Handler schlank, da Ereignisse schnell aufeinanderfolgen können, und begrenze bei Bedarf die Häufigkeit teurer Aktualisierungen.
Beispiele
(() => {
const viewportHeight = 80;
const contentHeight = 240;
function run(page, doc, createScrollBox) {
page.addEventListener("pagehide", (event) => {
console.log(`pagehide: persisted=${event.persisted}`);
});
function init() {
console.log("DOM ready");
const box = createScrollBox();
box.addEventListener("scroll", () => {
console.log(`scroll: ${box.scrollTop}`);
}, { once: true });
box.scrollTop = 40;
}
if (doc.readyState === "loading") {
doc.addEventListener("DOMContentLoaded", init, { once: true });
} else {
init();
}
}
if (typeof window !== "undefined" && typeof document !== "undefined") {
run(window, document, () => {
const box = document.createElement("div");
box.style.cssText = `width: 200px; height: ${viewportHeight}px; overflow: auto`;
const content = document.createElement("div");
content.style.height = `${contentHeight}px`;
content.textContent = "Scroll demo";
box.append(content);
document.body.append(box);
return box;
});
return;
}
// Node.js stand-ins exercise the same listeners without a browser DOM.
class ScrollBox extends EventTarget {
#offset = 0;
get scrollTop() {
return this.#offset;
}
set scrollTop(value) {
const offset = Math.min(Math.max(0, value), contentHeight - viewportHeight);
if (offset === this.#offset) return;
this.#offset = offset;
setTimeout(() => this.dispatchEvent(new Event("scroll")), 0);
}
}
const page = new EventTarget();
const doc = new EventTarget();
doc.readyState = "loading";
run(page, doc, () => new ScrollBox());
doc.readyState = "interactive";
doc.dispatchEvent(new Event("DOMContentLoaded"));
})();Ergebnis
DOM ready scroll: 40
Führe den Code einmal in der Konsole einer geladenen, leeren HTML-Seite aus. Die Initialisierung erfolgt sofort, und der Code scrollt den Container. Aktiviere das Beibehalten des Protokolls und navigiere im selben Tab zu einem anderen Dokument. Achte auf die mögliche zusätzliche Zeile `pagehide: persisted=true` oder `pagehide: persisted=false`. Sie ist nicht garantiert. In Node.js werden dieselben Handler für DOM-Bereitschaft und Scrollen mit Ersatzobjekten auf Basis von `EventTarget` ausgeführt, ohne das tatsächliche Browserverhalten zu prüfen.
Zugehörige Lektionen
- JavaScript · Lektion 45 · Fortgeschritten · Version: 4