Document: createEvent() メソッド

警告: createEvent とともに使用される多くのメソッド (initCustomEvent など) は非推奨です。 代わりに イベントのコンストラクター を使用してください。

指定された型のイベントを作成します。返されるオブジェクトは最初に初期化する必要があり、その後で EventTarget.dispatchEvent へ渡すことができます。

構文

js
createEvent(type)

引数

type

作成するイベント型を表す文字列です。取り得るイベント型は "UIEvents", "MouseEvents", "MutationEvents", "HTMLEvents" のいずれかです。詳しくはメモの項目を参照してください。

返値

イベントオブジェクトです。

例

js
// イベントを作成します。
const event = document.createEvent("Event");

// イベントの名前を 'build' に定義します。
event.initEvent("build", true, true);

// イベントを待受します。
elem.addEventListener(
  "build",
  (e) => {
    // e.target が elem に対応する
  },
  false,
);

// ターゲットは任意の Element やほかの EventTarget にすることができます。
elem.dispatchEvent(event);

メモ

createEvent() に渡すのに適したイベント型を表す文字列は DOM 標準で定義されています。ステップ 2 の表をご覧ください。現在はほとんどのイベントオブジェクトにコンストラクターがあり、それらはイベントオブジェクトのインスタンスを生成するために推奨される、現代的な方法であることに注意してください。

仕様書

Specification
DOM Standard
# dom-document-createevent

ブラウザーの互換性

BCD tables only load in the browser

関連情報