Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

CustomEvent: dane w detail i bąbelkowanie z bubbles

Użyj `detail`, aby przekazać dane w zdarzeniu niestandardowym, a `bubbles`, aby po obsłużeniu zdarzenia na elemencie docelowym mogły je odebrać nasłuchiwacze jego przodków w fazie bąbelkowania.

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

Składnia

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

new CustomEvent(type, options) tworzy zdarzenie DOM. type to nazwa zdarzenia, w której wielkość liter ma znaczenie, a options można pominąć. Konstruktor nie wysyła zdarzenia: robi to target.dispatchEvent(event), wywołując odpowiednie nasłuchiwacze synchronicznie, zanim zwróci wynik.

detail i bubbles pełnią niezależne funkcje. detail to dane zdarzenia (domyślnie null), dostępne przez właściwość event.detail tylko do odczytu. Można przekazać wartość prostą lub obiekt. Obiekt nie jest kopiowany ani zamrażany: nasłuchiwacz otrzymuje ten sam obiekt i może zmienić jego modyfikowalne właściwości.

Opcja bubbles ma domyślnie wartość false. bubbles: true włącza fazę bąbelkowania: po fazie docelowej zdarzenie może dotrzeć do nasłuchiwaczy przodków, o ile propagacja nie została zatrzymana. event.bubbles to właściwość tylko do odczytu odziedziczona z Event. Wartość false nie wyłącza nasłuchiwaczy na elemencie docelowym ani nasłuchiwaczy przodków w fazie przechwytywania (capture: true).

stopPropagation() zatrzymuje dalszą propagację; cancelable osobno decyduje, czy preventDefault() może anulować zdarzenie. Aby zdarzenie wysłane wewnątrz drzewa shadow DOM mogło bąbelkować poza tym drzewem, ustaw również composed: true (domyślnie false). Zdarzenie wysłane przez skrypt ma isTrusted równe false; nie traktuj go jako dowodu działania użytkownika. CustomEvent należy do API DOM, a nie ECMAScript 2024. Dostępność zależy od środowiska.

Przykłady

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

Wynik

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

Uruchom blok w Node.js 24 lub w konsoli przeglądarki. W przeglądarce elementy nie są dołączone do dokumentu, ale `child` ma rodzica i działa natywne bąbelkowanie DOM. W Node.js kod jawnie przekazuje zdarzenie do `parent`, aby zasymulować ten jeden etap bąbelkowania. W obu środowiskach `child` odbiera oba zdarzenia, a nasłuchiwacz `parent` zarejestrowany bez przechwytywania odbiera tylko drugie, z `score: 2`.

Powiązane lekcje

  • JavaScript · Lekcja 43 · Zaawansowany · Wersja: 4

Źródła