KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

CustomEvent: gegevens met detail en bubbling met bubbles

Gebruik `detail` om gegevens mee te geven aan een eigen event en `bubbles` om listeners zonder capture op voorouders het event na de doelfase te laten ontvangen.

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

Syntax

new CustomEvent(type)
new CustomEvent(type, { detail: payload, bubbles: true })
event.detail
event.bubbles
target.dispatchEvent(event)

new CustomEvent(type, options) maakt een DOM-event aan. type is een hoofdlettergevoelige eventnaam en options is optioneel. Het aanmaken vuurt het event niet af: roep target.dispatchEvent(event) aan om de toepasselijke listeners synchroon uit te voeren voordat de aanroep terugkeert.

detail en bubbles hebben onafhankelijke functies. detail bevat de gegevens en is standaard null. Listeners lezen de waarde via de alleen-lezen eigenschap event.detail. Je kunt een primitieve waarde of een object meegeven. Een object wordt niet gekopieerd of bevroren: listeners krijgen hetzelfde object en kunnen wijzigbare eigenschappen ervan aanpassen.

De optie bubbles is standaard false. Met bubbles: true schakel je de bubblingfase in: na de doelfase kan het event listeners op voorouders bereiken, tenzij de propagatie is gestopt. De alleen-lezen eigenschap event.bubbles wordt geërfd van Event. De waarde false schakelt listeners op het doel of capture-listeners (capture: true) op voorouders niet uit.

stopPropagation() stopt verdere propagatie. Los daarvan bepaalt cancelable of preventDefault() het event kan annuleren. Wil je een event dat binnen een shadow tree wordt afgevuurd daarbuiten laten bubbelen, stel dan ook composed: true in (standaard false). Een door een script afgevuurd event heeft isTrusted gelijk aan false; zie het niet als bewijs van een gebruikersactie. CustomEvent is een DOM-API en maakt geen deel uit van ECMAScript 2024. De beschikbaarheid hangt af van de runtime.

Voorbeelden

{
  const hasDOM = typeof document !== "undefined";
  const parent = hasDOM ? document.createElement("div") : new EventTarget();
  const child = hasDOM ? document.createElement("div") : new EventTarget();
  if (hasDOM) parent.appendChild(child);

  const type = "score-change";
  const lines = [];
  child.addEventListener(type, (event) => {
    lines.push(`child: ${event.detail.score}, bubbles=${event.bubbles}`);
  });
  parent.addEventListener(type, (event) => {
    lines.push(`parent: ${event.detail.score}, bubbles=${event.bubbles}`);
  });

  function dispatchFromChild(event) {
    child.dispatchEvent(event);
    // Without a DOM tree, model just the bubbling step to one parent.
    if (!hasDOM && event.bubbles && !event.cancelBubble) {
      parent.dispatchEvent(event);
    }
  }

  dispatchFromChild(new CustomEvent(type, { detail: { score: 1 } }));
  dispatchFromChild(new CustomEvent(type, {
    detail: { score: 2 },
    bubbles: true,
  }));

  console.log(lines.join("\n"));
}

Resultaat

child: 1, bubbles=false
child: 2, bubbles=true
parent: 2, bubbles=true

Voer het blok uit in Node.js 24 of in de browserconsole. In de browser zijn de elementen niet aan het document gekoppeld, maar `child` heeft wel een bovenliggend element en de ingebouwde DOM-bubbling werkt. In Node.js stuurt de code het event expliciet door naar `parent` om die ene bubblingstap na te bootsen. In beide omgevingen ontvangt `child` beide events; de listener zonder capture op `parent` ontvangt alleen het tweede, met `score: 2`.

Gerelateerde lessen

  • JavaScript · Les 43 · Gevorderd · Versie: 4

Bronnen