SubmitEvent()

Baseline Widely available

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

SubmitEvent() コンストラクターは、新しい SubmitEvent オブジェクトを作成して返します。これは HTML フォームで発行された submit イベントを表現するために使用されます。

構文

js
new SubmitEvent(type)
new SubmitEvent(type, options)

引数

type

イベントの名前を表す文字列。 大文字と小文字は区別され、ブラウザーは常に submit に設定します。

options 省略可

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

submitter 省略可

フォームを送信するきっかけとなった送信ボタンである HTMLElement オブジェクトです。

返値

指定された入力コントロールを使用して構成された SubmitEvent オブジェクト。

このコードでは、現在の文書内のフォームを探し、そのフォームに submit クラスを持つ HTML <button> 探します。 次に、新しい SubmitEvent を作成し、その submitter には、特定したボタン(またはボタンが見つからなかった場合は null )を設定します。そして、イベントをフォームに送信し、ボタンによって送信されたことをフォームに指示します。

js
const form = document.querySelector("form");
const formTrigger = form.querySelector("button.submit");
const submitEvent = new SubmitEvent("submit", { submitter: formTrigger });

form.dispatchEvent(submitEvent);

この例はやや作為的なもので、ほぼすべての処理をもっと簡単に行うことができますが、これによって処理を深く制御することができ、それが有用となる場合があります。

仕様書

Specification
HTML Standard
# submitevent

ブラウザーの互換性

BCD tables only load in the browser