CKTIS / JavaScript
Die Ereignisse `scroll` und `resize` und die Option `passive`
Wähle das passende Ziel für Scroll- und Größenänderungsereignisse und lerne, wann ein passiver Listener das Unterbinden der Standardaktion beeinflusst.
Version: Current web platform; runtime support varies
Syntax
// ECMAScript 2024 identifies the JavaScript language reference, not the version of these browser APIs.
// The DOM Standard defines the passive listener option, CSSOM View defines scroll and resize,
// and the Resize Observer specification defines ResizeObserver.
document.addEventListener("scroll", onPageScroll);
scrollContainer.addEventListener("scroll", onElementScroll);
window.addEventListener("resize", onViewportResize);
scrollContainer.addEventListener("wheel", onWheel, { passive: true });
scrollContainer.removeEventListener("wheel", onWheel);
const observer = new ResizeObserver(onElementResize);
observer.observe(element);
// When observation is no longer needed:
observer.disconnect();Registriere scroll auf document für das Scrollen der Seite oder direkt auf dem scrollbaren Element für Änderungen im Container. scroll meldet eine Positionsänderung, unabhängig davon, ob sie durch den Nutzer oder durch Code ausgelöst wurde. wheel meldet eine Eingabe, die nicht zwingend zum Scrollen führt. Registriere resize auf window, um Größenänderungen des Viewports zu erkennen; das Ereignis nimmt nicht an der Bubbling-Phase teil. Verwende ResizeObserver, um die Größe eines Elements zu beobachten.
Übergib { passive: true } im Optionsobjekt als drittes Argument von addEventListener(); ein einzelner boolescher Wert an dieser Stelle setzt capture, nicht passive. In einem passiven Listener bleibt preventDefault() wirkungslos und kann eine Warnung auslösen. Mit { passive: false } lässt sich die Standardaktion nur unterbinden, wenn event.cancelable wahr ist. Vom Browser ausgelöste scroll-Ereignisse des Dokuments oder eines Elements und resize-Ereignisse des Fensters sind nicht abbrechbar; die Option ändert das nicht.
Bei Eingaben wie wheel oder touchmove kann der Browser mit einem passiven Listener scrollen, ohne dessen Ende abzuwarten. Ohne Angabe kann der Standardwert vom Ereignis, vom Ziel und vom Browser abhängen. Setze passive: true, wenn du die Eingabe nur beobachtest. Musst du die Aktion unterbinden, setze passive: false und prüfe event.cancelable.
passive senkt weder die Aufrufhäufigkeit noch den Aufwand pro Aufruf. Halte Handler für häufige Ereignisse kurz; begrenze bei Bedarf die Häufigkeit teurer Arbeit mit einem Timer. requestAnimationFrame() hilft, visuelle Änderungen an Frames auszurichten, garantiert aber allein keine geringere Rate als scroll.
Rufe zum Aufräumen removeEventListener() am selben Ziel mit demselben Typ, demselben Callback und demselben capture-Wert auf; passive wird beim Abgleich nicht berücksichtigt. Diese APIs gehören zur Webplattform, nicht zu ECMAScript 2024. Prüfe die Unterstützung in deiner Zielumgebung.
Beispiele
{
const cases = [
["scroll", false, false],
["resize", false, false],
["wheel", true, true],
["wheel", true, false],
];
for (const [type, cancelable, passive] of cases) {
const target = new EventTarget();
target.addEventListener(type, (event) => event.preventDefault(), { passive });
const event = new Event(type, { cancelable });
target.dispatchEvent(event);
console.log(`${type} cancelable=${event.cancelable} passive=${passive} defaultPrevented=${event.defaultPrevented}`);
}
}Ergebnis
scroll cancelable=false passive=false defaultPrevented=false resize cancelable=false passive=false defaultPrevented=false wheel cancelable=true passive=true defaultPrevented=false wheel cancelable=true passive=false defaultPrevented=true
Führe den Code in einer Browserkonsole aus. Die synthetischen Ereignisse scrollen die Seite nicht und ändern die Fenstergröße nicht. Nur der letzte Fall setzt `defaultPrevented` auf `true`: Das Ereignis ist abbrechbar und der Listener nicht passiv. Der passive Abbruchversuch kann eine separate Warnung auslösen.
Zugehörige Lektionen
- JavaScript · Lektion 11 · Fortgeschritten · Version: 4
Quellen
- Document: scroll event
- Element: scroll event
- Window: resize event
- ResizeObserver
- EventTarget: addEventListener() method
- EventTarget: removeEventListener() method
- Event: preventDefault() method
- Element: wheel event
- Event: Event() constructor
- EventTarget: dispatchEvent() method
- HTML Standard: Processing model
- ECMAScript 2024 Language Specification: Hosts and Implementations