Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

CustomEvent — eventos com dados personalizados

CustomEvent estende Event com detail, permitindo que dados definidos pela aplicação cheguem aos ouvintes do evento.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

new CustomEvent(type, { detail: null, bubbles: false, cancelable: false, composed: false })

CustomEvent é uma interface da Web API do DOM Standard, não de ECMAScript. O seu construtor aceita um nome de evento e opções facultativas. A opção detail permite transmitir qualquer valor de JavaScript, exceto undefined. Se omitires esta opção ou passares explicitamente undefined, o Web IDL utiliza o valor predefinido null. Os objetos não são copiados.

Criar um evento não o envia: chama dispatchEvent() num EventTarget. Regista os ouvintes com addEventListener(). O envio é síncrono. As opções bubbles, cancelable e composed são false por predefinição. Verifica a disponibilidade da API no navegador de destino; a versão de Node do repositório não a confirma.

Exemplos

{
  const target = new EventTarget();
  target.addEventListener("score", (event) => {
    console.log(`score=${event.detail}`);
  });
  target.dispatchEvent(new CustomEvent("score", { detail: 7 }));
  console.log("done");
}

Resultado

score=7
done

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes