CustomEvent: CustomEvent() コンストラクター

Baseline 広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。

もっと詳しく
完全な互換性情報を見る

CustomEvent() コンストラクターは新しい CustomEvent を作成します。

構文

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

引数

type

イベントの名前を表す文字列です。イベント名は大文字小文字を区別します。

options 省略可

オブジェクトで、 Event() で定義されるプロパティに加えて、以下のプロパティを指定することができます。

detail 省略可: イベントと関連付けられたイベント依存の値。この値は、ハンドラーが CustomEvent.detail プロパティを用いて利用できるようになります。既定値は null です。

返値

新しい CustomEvent オブジェクトです。

例

// カスタムイベントを作成
const catFound = new CustomEvent("animalfound", {
 detail: {
 name: "cat",
 },
});
const dogFound = new CustomEvent("animalfound", {
 detail: {
 name: "dog",
 },
});
// 適切なイベントリスナーを追加
obj.addEventListener("animalfound", (e) => console.log(e.detail.name));
// イベントの配信
obj.dispatchEvent(catFound);
obj.dispatchEvent(dogFound);
// "cat" および "dog" がコンソールの出力される

その他の例がイベントの作成と起動にあります。