ElementInternals: setFormValue() メソッド

Baseline 2023

Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

setFormValue() は ElementInternals インターフェイスのメソッドで、このメソッドは、要素の送信値と状態を設定し、これらをユーザーエージェントに伝えます。

構文

setFormValue(value)
setFormValue(value, state)

引数

value: サーバーに送信する値として、File、文字列、FormData のいずれかを指定します。
state 省略可: File、文字列、FormData のいずれかで、ユーザーの入力を表します。これにより、アプリケーションは必要に応じて、ユーザーが送信した情報を、ユーザーが入力した形式で再表示することができます。

メモ: 一般的に、 state はユーザーがー指定した情報を渡すために、 value はサニタイズ後、サーバーに送信するのに適した情報を渡すために使用されます。たとえば、カスタム要素で日付の入力を求められた場合、ユーザーは「3/15/2019」と入力するかもしれません。これは state です。サーバーは 2019-03-15 という日付書式を期待しているので、この書式の日付が value として渡されます。

返値

undefined です。

例外

NotSupportedError DOMException: 要素の formAssociated プロパティが true に設定されていない場合に発生します。

例

次の例では、チェックボックスのカスタム要素で、サーバーに送信する値として on を、状態として checked を設定しています。

this.internals_.setFormValue("on", "checked");

仕様書

Specification
HTML # dom-elementinternals-setformvalue

ブラウザーの互換性

BCD tables only load in the browser