CKTIS / JavaScript
CustomEvent: data v detail a bublání s bubbles
Pomocí `detail` předej data ve vlastní události a pomocí `bubbles` umožni, aby ji po cílové fázi zachytily posluchače na předcích registrované bez režimu zachytávání.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
new CustomEvent(type)
new CustomEvent(type, { detail: payload, bubbles: true })
event.detail
event.bubbles
target.dispatchEvent(event)new CustomEvent(type, options) vytvoří událost DOM. V názvu události type záleží na velikosti písmen. Argument options je nepovinný. Vytvoření událost nevyšle: zavolej target.dispatchEvent(event), které příslušné posluchače vyvolá synchronně, než se volání vrátí.
detail a bubbles mají nezávislé účely. detail nese data a jeho výchozí hodnota je null. Posluchače data čtou z vlastnosti event.detail, která je jen pro čtení. Můžeš předat primitivní hodnotu nebo objekt. Objekt se nekopíruje ani nezmrazuje: posluchače dostanou tentýž objekt a mohou měnit jeho měnitelné vlastnosti.
Výchozí hodnota volby bubbles je false. bubbles: true zapne fázi bublání: po cílové fázi se událost může dostat k posluchačům na předcích, pokud nebylo šíření zastaveno. Vlastnost event.bubbles je jen pro čtení a dědí se z Event. Hodnota false nevypíná posluchače na cíli ani posluchače na předcích registrované pro fázi zachytávání (capture: true).
stopPropagation() zastaví další šíření. Nezávisle na tom cancelable určuje, zda lze událost zrušit pomocí preventDefault(). Aby událost vyslaná uvnitř stromu shadow DOM mohla vybublat i mimo něj, nastav také composed: true (výchozí hodnota je false). Událost vyslaná skriptem má isTrusted rovno false; neber ji jako důkaz akce uživatele. CustomEvent je API DOM, nikoli součást ECMAScriptu 2024. Dostupnost závisí na běhovém prostředí.
Příklady
{
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"));
}Výsledek
child: 1, bubbles=false child: 2, bubbles=true parent: 2, bubbles=true
Spusť blok v Node.js 24 nebo v konzoli prohlížeče. V prohlížeči nejsou prvky připojené k dokumentu, ale `child` má rodiče a uplatní se nativní bublání DOM. V Node.js kód výslovně předá událost na `parent`, aby napodobil právě tento jeden krok bublání. V obou prostředích `child` přijme obě události; posluchač bez režimu zachytávání na `parent` přijme jen druhou, se `score: 2`.
Související lekce
- JavaScript · Lekce 43 · Pokročilá · Verze: 4