CustomEvent: CustomEvent() コンストラクター
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.
CustomEvent() コンストラクターは新しい CustomEvent を作成します。
構文
js
new CustomEvent(type)
new CustomEvent(type, options)
引数
type-
イベントの名前を表す文字列です。イベント名は大文字小文字を区別します。
options省略可-
オブジェクトで、
Event()で定義されるプロパティに加えて、以下のプロパティを指定することができます。detail省略可-
イベントと関連付けられたイベント依存の値。この値は、ハンドラーが
CustomEvent.detailプロパティを用いて利用できるようになります。 既定値はnullです。
返値
新しい CustomEvent オブジェクトです。
例
js
// カスタムイベントを作成
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" がコンソールの出力される
その他の例がイベントの作成と起動にあります。
仕様書
| Specification |
|---|
| DOM # ref-for-dom-customevent-customevent |