База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

CustomEvent: данни в detail и възходящо разпространение с bubbles

Използвай `detail`, за да предадеш данни в събитие по избор, и `bubbles`, за да го получат след целевата фаза слушателите на предците, които не са регистрирани за прихващане.

Версия: ECMAScript 2024 and the current web platform; runtime support varies

Синтаксис

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

new CustomEvent(type, options) създава DOM събитие. type е името на събитието, в което главните и малките букви се различават, а options е незадължителен аргумент. Създаването не изпраща събитието: извикай target.dispatchEvent(event), за да се изпълнят съответните слушатели синхронно, преди извикването да върне резултат.

detail и bubbles имат независими роли. detail съдържа данните и по подразбиране е null. Слушателите четат данните чрез свойството event.detail, което е само за четене. Можеш да предадеш примитивна стойност или обект. Обектът не се копира и не се замразява: слушателите получават същия обект и могат да променят неговите изменяеми свойства.

Опцията bubbles по подразбиране е false. bubbles: true включва фазата на възходящо разпространение: след целевата фаза събитието може да достигне до слушателите на предците, ако разпространението не е спряно. Свойството event.bubbles е само за четене и се наследява от Event. Стойността false не изключва слушателите на целта или слушателите на предците във фазата на прихващане (capture: true).

stopPropagation() спира по-нататъшното разпространение. Независимо от това cancelable определя дали preventDefault() може да отмени събитието. За да може събитие, изпратено вътре в дърво на shadow DOM, да се разпространи възходящо извън него, задай и composed: true (по подразбиране false). Събитие, изпратено от скрипт, има isTrusted със стойност false; не го приемай като доказателство за действие на потребителя. CustomEvent е API на DOM, а не част от ECMAScript 2024. Наличността зависи от средата за изпълнение.

Примери

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

Резултат

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

Изпълни блока в Node.js 24 или в конзолата на браузъра. В браузъра елементите не са свързани с документа, но `child` има родител и се използва вграденото възходящо разпространение на DOM. В Node.js кодът изрично препраща събитието към `parent`, за да симулира само тази стъпка на възходящото разпространение. И в двете среди `child` получава и двете събития; слушателят на `parent`, който не е регистриран за прихващане, получава само второто, със `score: 2`.

Свързани уроци

  • JavaScript · Урок 43 · Напреднало · Версия: 4

Източници