Form 表单

表单包含 input、radio、select、checkbox 等需要用户输入的组件。 使用表单，您可以收集、验证和提交数据。

提示

Form 组件已经从 2. x 的 Float 布局升级为 Flex 布局。

import { createApp } from 'vue'
import { ElForm, ElFormItem } from '@szhn/dh-design-pc'

const app = createApp()
app.use(ElForm)
app.use(ElFormItem)

典型表单

最基础的表单包括各种输入表单项，比如input、select、radio、checkbox等。

提示

TIP W3C 标准定义： 当一个表单中只有一个单行文本输入字段时， 浏览器应当将在此字段中按下 Enter （回车键）的行为视为提交表单的请求。 如果希望阻止这一默认行为，可以在 <el-form> 标签上添加 @submit.prevent 。

行内表单

当垂直方向空间受限且表单较简单时，可以在一行内放置表单。

对齐方式

根据你们的设计情况，来选择最佳的标签对齐方式。

您可以分别设置 el-form-item 的 label-position。如果值为空，则会使用 el-form 的 label-position。

表单校验

Form 组件允许你验证用户的输入是否符合规范，来帮助你找到和纠正错误。

自定义校验规则

这个例子中展示了如何使用自定义验证规则来完成密码的二次验证。

提示

TIP 自定义的校验回调函数必须被调用。 校验规则参见 async-validator

添加/删除表单项

数字类型验证

提示

TIP 当一个 el-form-item 嵌套在另一个 el-form-item 中时，其标签宽度将为 0 。 如果需要可以为 el-form-item 单独设置 label-width 属性。

尺寸控制

表单中的所有子组件都继承了该表单的 size 属性。 同样，form-item 也有一个 size 属性。

无障碍

当在 el-form-item 内只有一个输入框（或相关的控制部件，如选择或复选框），表单项的标签将自动附加在那个输入框上。 如果 el-form-item内有多个 input，则表单项会被设置成 WAI-ARIA 组 的 role。 在这种情况下，需要手动给每个 input 指定访问标签。

Form API

Form Attributes

属性名	说明	类型	默认值
model	表单数据对象	object	—
rules	表单验证规则	object	—
inline	行内表单模式	boolean	false
label-position	表单域标签的位置， 当设置为 left 或 right 时，则也需要设置 label-width 属性	enum	right
label-width	标签的长度，例如 '50px'。 作为 Form 直接子元素的 form-item 会继承该值。 可以使用 auto。	string / number	''
label-suffix	表单域标签的后缀	string	''
hide-required-asterisk	是否隐藏必填字段标签旁边的红色星号。	boolean	false
require-asterisk-position	星号的位置。	enum	left
show-message	是否显示校验错误信息	boolean	true
inline-message	是否以行内形式展示校验信息	boolean	false
status-icon	是否在输入框中显示校验结果反馈图标	boolean	false
validate-on-rule-change	是否在 rules 属性改变后立即触发一次验证	boolean	true
size	用于控制该表单内组件的尺寸	enum	—
disabled	是否禁用该表单内的所有组件。	boolean	false
scroll-to-error	当校验失败时，滚动到第一个错误表单项	boolean	false
scroll-into-view-options	当校验有失败结果时，滚动到第一个失败的表单项目 可通过 scrollIntoView 配置	object / boolean	true

Form Events

名称	说明	类型
validate	任一表单项被校验后触发	Function

Form Slots

插槽名	说明	子标签
default	自定义默认内容	FormItem

Form Exposes

名称	说明	类型
validate	对整个表单的内容进行验证。 接收一个回调函数，或返回 Promise。	Function
validateField	验证具体的某个字段。	Function
resetFields	重置该表单项，将其值重置为初始值，并移除校验结果	Function
scrollToField	滚动到指定的字段	Function
clearValidate	清理某个字段的表单验证信息。	Function
fields	获取所有字段的 context	array
getField	获取字段的 context	Function
setInitialValues	设置表单字段的初始值。 当调用 resetFields 时，字段将重置为这些值。	Function

FormItem API

FormItem Attributes

属性名	说明	类型	Default
prop	model 的键名。 它可以是属性的路径（如 a.b.0 或 ['a', 'b', '0']）。 在使用了 validate、resetFields 的方法时，该属性是必填的。	string / string[]	—
label	标签文本	string	—
label-position	表单域标签的位置， 当设置为 left 或 right 时，则也需要设置 label-width 属性 默认会继承 Form的label-position	enum	''
label-width	标签宽度，例如 '50px'。 可以使用 auto。	string / number	—
required	是否为必填项，如不设置，则会根据校验规则确认	boolean	—
rules	表单验证规则, 具体配置见下表, 更多内容可以参考async-validator	object	—
error	表单域验证错误时的提示信息。设置该值会导致表单验证状态变为 error，并显示该错误信息。	string	—
show-message	是否显示校验错误信息	boolean	true
inline-message	是否在行内显示校验信息	boolean	false
size	用于控制该表单域下组件的默认尺寸	enum	—
for	和原生标签相同能力	string	—
validate-status	formitem 校验的状态	enum	—

FormItemRule

名称	说明	类型	默认值
trigger	验证逻辑的触发方式	enum	—

提示

如果您不想根据输入事件触发验证器， 在相应的输入类型组件上设置 validate-event 属性为 false (<el-input>, <el-radio>, <el-select>, ……).

FormItem Slots

插槽名	说明	类型
default	表单的内容。	—
label	标签位置显示的内容	object
error	验证错误信息的显示内容	object

FormItem Exposes

名称	说明	类型
size	表单项大小	object
validateMessage	校验消息	object
validateState	校验状态	object
validate	验证表单项	Function
resetField	对该表单项进行重置，将其值重置为初始值并移除校验结果	Function
clearValidate	移除该表单项的校验结果	Function
setInitialValue	设置表单字段的初始值。 当调用 resetFields 时，字段将重置为这些值。	Function