CKTIS / JavaScript
De optie `passive` in `EventTarget.addEventListener()`
Met `passive: true` ontvangt een listener de gebeurtenis, maar kan hij de standaardactie niet annuleren. De optie weglaten is niet altijd hetzelfde als `false` opgeven.
Versie: 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 is een optionele booleaanse eigenschap van het object dat je als derde argument meegeeft aan target.addEventListener(type, listener, options). Is het derde argument een losse booleaanse waarde, dan stelt die alleen capture in, niet passive. Dit is een DOM-API van het webplatform, geen taalfunctie van ECMAScript 2024; controleer de ondersteuning in je doelomgeving.
Met passive: true wordt de listener nog steeds uitgevoerd, maar een aanroep van event.preventDefault() vanuit die listener heeft geen effect en kan een waarschuwing in de console opleveren. Dit verandert de propagatie van de gebeurtenis niet. Met passive: false kan de listener de standaardactie annuleren via preventDefault(), maar alleen als event.cancelable true is.
Laat je passive weg, dan schrijft de DOM-standaard false voor als standaardwaarde, behalve voor wheel, mousewheel, touchstart en touchmove bij registratie op Window, Document, document.documentElement of document.body: in die gevallen schrijft de standaard true voor. Ondersteuning van de optie zelf garandeert niet dat deze standaardwaarden worden toegepast: wanneer true als standaard gold, verschilde per browser en versie, ook bij Safari. Geef expliciet false op als je de actie moet annuleren. Gebruik true als je invoer alleen observeert, zodat de browser kan beginnen met scrollen zonder op die listener te wachten. De scroll-gebeurtenis zelf is niet annuleerbaar.
Opnieuw registreren op hetzelfde doel met hetzelfde type, dezelfde callback en dezelfde capture-waarde wijzigt passive niet. Verwijder de listener met removeEventListener() en het bijbehorende type, de callback en de capture-waarde, en voeg hem vervolgens opnieuw toe. passive bepaalt niet welke listener wordt verwijderd en regelt de levensduur ervan niet.
Voorbeelden
{
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);
}
}Resultaat
passive=true, defaultPrevented=false, dispatchEvent=true passive=false, defaultPrevented=true, dispatchEvent=false
Elke iteratie verstuurt een nieuwe, annuleerbare synthetische gebeurtenis. `defaultPrevented` geeft aan of die is geannuleerd, en `dispatchEvent()` geeft alleen `false` terug in de iteratie waarin de annulering lukt. De browser kan een waarschuwing tonen; het voorbeeld meet geen scrollprestaties.
Gerelateerde lessen
- JavaScript · Les 33 · Gevorderd · Versie: 4
- JavaScript · Les 36 · Gevorderd · Versie: 4
- JavaScript · Les 45 · Gevorderd · Versie: 4