CKTIS / JavaScript
Události DOMContentLoaded, pagehide a scroll
Rozliš připravenost DOM, opuštění stránky a posouvání. Vyber správný objekt pro posluchač a počítej s možným obnovením stránky z mezipaměti bfcache.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
document.addEventListener("DOMContentLoaded", onReady, { once: true });
window.addEventListener("pagehide", onPageHide);
document.addEventListener("scroll", onDocumentScroll);
scrollBox.addEventListener("scroll", onElementScroll);Tyto události prohlížeče odpovídají na tři různé otázky: Je DOM připraven k inicializaci? Opouští prohlížeč dokument? Změnila se poloha posunu? Patří do webové platformy, nikoli do ECMAScriptu. Mimo prohlížeč nepředpokládej dostupnost document a window.
DOMContentLoaded se vyvolá na document po dokončení analýzy HTML, provedení klasických skriptů s defer a zahájení vyhodnocování modulů bez async naplánovaných na konec analýzy. Událost nečeká na dokončení asynchronního vyhodnocování modulů: await na nejvyšší úrovni v závislosti může odložit spuštění těla modulu, který ji importuje, až po vyvolání události. Na rozdíl od load nečeká na obrázky, vnořené rámce ani skripty async. Šablona stylů ji může nepřímo zpozdit, pokud blokuje skript.
Pokud se inicializační kód může spustit pozdě, zkontroluj document.readyState. Při hodnotě "loading" přidej jednorázový posluchač události DOMContentLoaded; jinak inicializuj ihned. "interactive" znamená, že analýza skončila, ne že už proběhla událost nebo že skončily ostatní odložené skripty.
Událost pagehide poslouchej na window, pokud chceš reagovat na opuštění dokumentu, ne na pouhé přepnutí karty. U této události PageTransitionEvent znamená event.persisted === true, že dokument lze případně obnovit z mezipaměti pro přechod zpět a vpřed (bfcache), ale obnovení není jisté; false znamená, že se dokument pro další použití neuchovává. Po obnovení pokračuj pomocí pageshow s persisted === true, nikoli pomocí DOMContentLoaded. pagehide může chybět, například když systém ukončí mobilní prohlížeč. Důležitý stav ukládej průběžně; skrytí karty zjišťuj pomocí visibilitychange a stavu "hidden".
Při posouvání stránky poslouchej scroll na document a čti window.scrollY; u posuvného kontejneru poslouchej přímo na prvku a čti jeho scrollTop. Událost může vyvolat i posun provedený kódem a neoznamuje konec posouvání. Obsluha by měla být nenáročná, protože události mohou přicházet rychle za sebou; v případě potřeby omez četnost nákladných aktualizací.
Příklady
(() => {
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"));
})();Výsledek
DOM ready scroll: 40
Spusť kód jednou v konzoli načtené prázdné stránky HTML. Inicializace proběhne ihned a kód posune obsah kontejneru. Zapni uchování protokolu a přejdi ve stejné kartě na jiný dokument. Sleduj, zda přibude řádek `pagehide: persisted=true` nebo `pagehide: persisted=false`. Tento řádek není zaručen. V Node.js náhradní objekty založené na `EventTarget` spouštějí stejné obsluhy událostí pro připravenost DOM a posouvání, ale neověřují skutečné chování prohlížeče.
Související lekce
- JavaScript · Lekce 45 · Pokročilá · Verze: 4