ElementInternals:setFormValue() 方法

基线 2023

新功能

2023 年 3 月起,此功能在最新的设备和浏览器版本上都能正常运行。此功能可能无法在较旧的设备或浏览器上正常运行。

setFormValue() 方法是 ElementInternals 接口的方法,用于设置元素的提交值和状态,并将这些信息传达给用户代理。

语法

js
setFormValue(value)
setFormValue(value, state)

参数

value

一个 File、一个字符串或一个 FormData,作为要提交到服务器的值。

state 可选

一个 File、一个字符串或一个 FormData,表示用户做出的输入。这允许应用程序根据需要重新显示用户提交的信息,并以用户提交的信息形式显示。

注意: 通常,state 用于传递用户指定的信息,value 适合在进行清理后提交给服务器。例如,如果自定义元素要求用户提交日期,用户可能会输入“3/15/2019”。这将是 state。服务器期望日期格式为 2019-03-15,此格式的日期将作为 value 传递。

返回值

未定义。

异常

NotSupportedError DOMException

如果元素的 formAssociated 属性未设置为 true,则抛出该异常。

示例

在以下示例中,复选框自定义元素将 on 设置为发送到服务器的值,并将 checked 设置为状态。

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

规范

规范
HTML 标准
# dom-elementinternals-setformvalue

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。