WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Die Option `passive` in `EventTarget.addEventListener()`

Mit `passive: true` empfängt ein Listener das Ereignis, kann dessen Standardaktion aber nicht verhindern. Die Option wegzulassen ist nicht immer dasselbe wie `false` anzugeben.

Version: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

target.addEventListener(type, listener)
target.addEventListener(type, listener, useCapture)
target.addEventListener(type, listener, { passive: true })
target.addEventListener(type, listener, { passive: false })

passive ist eine optionale boolesche Eigenschaft des Objekts, das als drittes Argument an target.addEventListener(type, listener, options) übergeben wird. Ein einzelner boolescher Wert als drittes Argument setzt nur capture, nicht passive. Die Methode gehört zur DOM-API der Webplattform, nicht zur Sprache ECMAScript 2024; prüfe die Unterstützung in deiner Zielumgebung.

Mit passive: true wird der Listener weiterhin ausgeführt. Ruft er event.preventDefault() auf, bleibt der Aufruf wirkungslos und kann eine Konsolenwarnung auslösen. Die Ereignisausbreitung ändert sich dadurch nicht. Mit passive: false kann der Listener die Standardaktion mit preventDefault() verhindern, aber nur wenn event.cancelable den Wert true hat.

Ohne Angabe von passive sieht der DOM-Standard false als Standardwert vor, außer für wheel, mousewheel, touchstart und touchmove bei Registrierung auf Window, Document, document.documentElement oder document.body: In diesen Fällen sieht er true vor. Aus der Unterstützung der Option allein folgt nicht, dass diese Standardwerte gelten: Je nach Browserversion, auch bei Safari, wurde true in unterschiedlichen Fällen als Standard verwendet. Gib false ausdrücklich an, wenn du die Aktion verhindern musst. Mit true kannst du Eingaben beobachten, ohne dass der Browser vor dem Scrollen auf diesen Listener warten muss. Das scroll-Ereignis selbst ist nicht abbrechbar.

Erneutes Registrieren am selben Ziel mit demselben Typ, derselben Callback-Funktion und demselben capture-Wert ändert passive nicht. Entferne den Listener mit removeEventListener() unter Angabe des passenden Typs, Callbacks und capture-Werts und füge ihn dann erneut hinzu. passive spielt beim Abgleich zur Entfernung keine Rolle und steuert nicht die Lebensdauer des Listeners.

Beispiele

{
  const target = new EventTarget();
  const type = "passive-demo";
  const listener = (event) => event.preventDefault();

  for (const passive of [true, false]) {
    target.addEventListener(type, listener, { passive });
    const event = new Event(type, { cancelable: true });
    const result = target.dispatchEvent(event);
    console.log(`passive=${passive}, defaultPrevented=${event.defaultPrevented}, dispatchEvent=${result}`);
    target.removeEventListener(type, listener);
  }
}

Ergebnis

passive=true, defaultPrevented=false, dispatchEvent=true
passive=false, defaultPrevented=true, dispatchEvent=false

Jeder Durchlauf löst ein neues, abbrechbares synthetisches Ereignis aus. `defaultPrevented` zeigt an, ob es abgebrochen wurde, und `dispatchEvent()` gibt nur beim erfolgreichen Abbruch `false` zurück. Der Browser kann eine Warnung anzeigen; das Beispiel misst keine Scroll-Leistung.

Zugehörige Lektionen

  • JavaScript · Lektion 33 · Fortgeschritten · Version: 4
  • JavaScript · Lektion 36 · Fortgeschritten · Version: 4
  • JavaScript · Lektion 45 · Fortgeschritten · Version: 4

Quellen