CKTIS / JavaScript
CustomEvent: podatki v detail in mehurjenje z bubbles
Z `detail` posreduješ podatke v dogodku po meri, z `bubbles` pa omogočiš, da ga po ciljni fazi prejmejo poslušalci na prednikih, ki niso registrirani za zajemanje.
Različica: ECMAScript 2024 and the current web platform; runtime support varies
Sintaksa
new CustomEvent(type)
new CustomEvent(type, { detail: payload, bubbles: true })
event.detail
event.bubbles
target.dispatchEvent(event)new CustomEvent(type, options) ustvari dogodek DOM. type je ime dogodka, pri katerem se razlikujejo velike in male črke, options pa je neobvezen argument. Ustvarjanje ne sproži dogodka: pokliči target.dispatchEvent(event), da se ustrezni poslušalci izvedejo sinhrono, preden se klic vrne.
detail in bubbles imata neodvisni vlogi. detail vsebuje podatke in ima privzeto vrednost null. Poslušalci ga berejo prek lastnosti event.detail, ki je samo za branje. Posreduješ lahko primitivno vrednost ali objekt. Objekt se ne kopira in ne zamrzne: poslušalci prejmejo isti objekt in lahko spremenijo njegove spremenljive lastnosti.
Možnost bubbles ima privzeto vrednost false. bubbles: true omogoči fazo mehurjenja: po ciljni fazi lahko dogodek doseže poslušalce na prednikih, če širjenje ni bilo ustavljeno. Lastnost event.bubbles je samo za branje in je podedovana iz Event. Vrednost false ne onemogoči poslušalcev na cilju niti poslušalcev na prednikih v fazi zajemanja (capture: true).
stopPropagation() ustavi nadaljnje širjenje; neodvisno od tega cancelable določa, ali lahko preventDefault() prekliče dogodek. Da dogodek, sprožen znotraj drevesa shadow DOM, lahko z mehurjenjem doseže elemente zunaj njega, nastavi tudi composed: true (privzeto false). Dogodek, ki ga sproži skript, ima isTrusted nastavljen na false; ne obravnavaj ga kot dokaz dejanja uporabnika. CustomEvent je API DOM in ni del ECMAScripta 2024. Razpoložljivost je odvisna od izvajalnega okolja.
Primeri
{
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"));
}Rezultat
child: 1, bubbles=false child: 2, bubbles=true parent: 2, bubbles=true
Zaženi blok v Node.js 24 ali v konzoli brskalnika. V brskalniku elementi niso priključeni na dokument, toda `child` ima starša, zato deluje vgrajeno mehurjenje DOM. V Node.js koda izrecno posreduje dogodek cilju `parent`, da ponazori ta posamezni korak mehurjenja. V obeh okoljih `child` prejme oba dogodka; poslušalec brez zajemanja na `parent` prejme samo drugega, s `score: 2`.
Povezane lekcije
- JavaScript · Lekcija 43 · Napredna · Različica: 4