CustomEvent: CustomEvent() Konstruktor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Der CustomEvent()-Konstruktor erstellt ein neues CustomEvent-Objekt.

Syntax

js
new CustomEvent(type)
new CustomEvent(type, options)

Parameter

type

Ein String, der den Namen des Ereignisses angibt. Ereignisnamen sind groß- und kleinschreibungsabhängig.

options Optional

Ein Objekt, das zusätzlich zu den in Event() definierten Eigenschaften die folgenden Eigenschaften haben kann:

detail Optional

Ein ereignisabhängiger Wert, der dem Ereignis zugeordnet ist. Dieser Wert ist dann für den Handler über die CustomEvent.detail-Eigenschaft verfügbar. Standardmäßig ist dieser Wert null.

Rückgabewert

Ein neues CustomEvent-Objekt.

Beispiel

js
// create custom events
const catFound = new CustomEvent("animalfound", {
  detail: {
    name: "cat",
  },
});
const dogFound = new CustomEvent("animalfound", {
  detail: {
    name: "dog",
  },
});

const element = document.createElement("div"); // create a <div> element

// add an appropriate event listener
element.addEventListener("animalfound", (e) => console.log(e.detail.name));

// dispatch the events
element.dispatchEvent(catFound);
element.dispatchEvent(dogFound);

// "cat" and "dog" logged in the console

Weitere Beispiele finden Sie unter Erstellen und Auslösen von Ereignissen.

Spezifikationen

Specification
DOM Standard
# ref-for-dom-customevent-customevent

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch