# Form 表单

# 代码演示

# API

# Form Attributes

参数	说明	类型	可选值	默认值	Version
hide-required-asterisk	是否隐藏必填字段的标签旁边的红色星号	Boolean	—	—	v2.0.0
inline	是否为行内表单	Boolean	—	—
inline-message	是否以行内形式展示校验信息	Boolean	—	—	v2.0.0
label-width	label的长度, 支持auto属性，label自由展开	String	—	—	v1.7.10
label-align	label对齐方式	String	'left' | 'right' | 'center' | 'top'	—
label-position	* 同label-align	String	'left' | 'right' | 'center' | 'top'	—	v2.0.0
label-suffix	表单域标签的后缀	String	—	—	v2.0.0
model	表单绑定的数据	Object	—	—
rules	表单的验证规则	Object	—	—
sizes	控制表单元素大小(已在v2.0.0被废弃, 被size代替)	String	'large' | 'medium' | 'small' | 'mini'	—
size	控制表单元素大小	String	'large' | 'medium' | 'small' | 'mini'	—
text	是否为纯文本表单	Boolean	—	—
show-message	是否显示提示文字	Boolean	—	true	v2.0.0
validate-on-rule-change	是否在 rules 属性改变后立即触发一次验证	Boolean	—	true	v2.0.0

# Form Methods

事件名称	说明	回调参数	Version
clearValidate	清除表单元素的验证结果(props可以是 string | array 如果不传参则默认清空所有表单元素的验证结果)	Function(props: string | array)	v1.5.22
resetFields	重置表单, 将字段值重置为初始值	—
validateField	验证表单部分字段	Function (props: array | string, cb)	v1.4.13
validateForm	验证表单(回调函数第一个参数valid表示表单是否验证成功, 第二个参数invalidFields是所有未通过验证的表单字段)	Function (cb: Function(valid, invalidFields))	v1.5.25
validate	* 同validateForm	Function (cb: Function(valid, invalidFields))	v2.0.0

# Form Events

事件名称	说明	回调参数	Version
validate	任一表单项被校验后触发	被校验的表单项 prop 值，校验是否通过，错误消息（如果存在）	v2.0.0

# Form-Item Attributes

参数	说明	类型	可选值	默认值	Version
label	label的文本值	String	—	—
label-width	label的长度, 支持auto(优先级高于form中的labelWidth属性)	String	—	—	v1.7.12
prop	在表单model中的所属字段, 需要验证或重置表单时必填	String	—	—
rules	该表单的验证规则	Array	—	—
required	是否必填	Boolean	—	true
show-message	是否显示提示文字	Boolean	—	true

# Form-Item Methods

事件名称	说明	回调参数	Version
clearValidate	对该表单项进行重置，将其值重置为初始值并移除校验结果	Function(props: string | array)	v1.5.22
resetField	移除该表单项的校验结果	—

# Form-Item Slots

参数	说明	Version
—	表单元素
label	表单的标签
error	自定义表单校验信息的显示方式，参数为 { error }	v2.0.0

# 贡献者

类型	参与者
设计者	UED视觉组
维护者	UED前端组