KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

De events `scroll` en `resize` en de optie `passive`

Kies het juiste doel voor scroll- en formaatwijzigingen en leer wanneer een passieve listener voorkomt dat je de standaardactie kunt annuleren.

Versie: 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();

Luister naar scroll op document als de pagina scrolt, of rechtstreeks op het scrollende element voor wijzigingen binnen een container. scroll meldt een positiewijziging, ongeacht of die door de gebruiker of door code is veroorzaakt. wheel meldt invoer die niet per se tot scrollen leidt. Luister naar resize op window wanneer de viewport van formaat verandert; dit event bubbelt niet. Gebruik ResizeObserver om de afmetingen van een element te volgen.

Geef { passive: true } mee in het optieobject als derde argument van addEventListener(); een losse boolean op die plek stelt capture in, niet passive. In een passieve listener heeft preventDefault() geen effect en kan het een waarschuwing opleveren. { passive: false } maakt het annuleren van de standaardactie alleen mogelijk als event.cancelable true is. Door de browser gegenereerde scroll-events van het document of een element en resize-events van het venster zijn niet annuleerbaar; de optie verandert dat niet.

Bij invoer zoals wheel of touchmove kan de browser met een passieve listener beginnen te scrollen zonder te wachten tot die listener klaar is. Laat je de optie weg, dan kan de standaardwaarde afhangen van het event, het doel en de browser. Gebruik passive: true als je de invoer alleen observeert. Moet je de actie annuleren, gebruik dan passive: false en controleer event.cancelable.

passive verlaagt noch de aanroepfrequentie, noch de kosten van het uitgevoerde werk. Houd handlers voor frequente events kort; gebruik zo nodig een timer om kostbaar werk minder vaak uit te voeren. requestAnimationFrame() helpt visuele wijzigingen af te stemmen op frames, maar garandeert op zichzelf geen lagere frequentie dan scroll.

Roep voor het opruimen removeEventListener() aan op hetzelfde doel, met hetzelfde type, dezelfde callback en dezelfde waarde voor capture; passive telt niet mee bij het zoeken naar de juiste registratie. Deze API’s horen bij het webplatform, niet bij ECMAScript 2024. Controleer de ondersteuning in je beoogde uitvoeromgeving.

Voorbeelden

{
  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}`);
  }
}

Resultaat

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

Voer de code uit in een browserconsole. De synthetische events scrollen de pagina niet en wijzigen het vensterformaat niet. Alleen het laatste geval zet `defaultPrevented` op `true`: het event is annuleerbaar en de listener is niet passief. De annuleringspoging in de passieve listener kan een aparte waarschuwing opleveren.

Gerelateerde lessen

  • JavaScript · Les 11 · Gevorderd · Versie: 4

Bronnen