Skip to content

Form 表单

表单用于数据收集、校验和提交,由 FormFormItem 组件组成。

基础用法

最简单的表单用法,包含表单数据和校验规则。

各种校验规则

支持多种校验规则:required、type、min、max、pattern 等。

自定义校验

使用 validator 函数实现自定义校验规则。

表单方法

通过 ref 获取表单实例,调用表单方法进行校验、重置等操作。

标签位置

通过 label-position 属性设置标签位置。

表单尺寸

通过 size 属性设置表单尺寸。

Form API

Form Attributes

参数说明类型默认值
model表单数据对象Record<string, any>
rules表单验证规则FormRules
label-width表单域标签的宽度string | number
label-position表单域标签的位置'left' | 'right' | 'top''right'
size表单尺寸'large' | 'default' | 'small''default'
disabled是否禁用表单booleanfalse
show-message是否显示校验错误信息booleantrue
validate-on-rule-change是否在规则改变时立即触发一次验证booleantrue

Form Methods

方法名说明参数
validate对整个表单进行校验(callback?: ValidateCallback) => void
validateField对部分表单字段进行校验(prop: string, callback?: (error?: string) => void) => void
clearValidate清空校验结果(props?: string | string[]) => void
resetFields重置表单字段() => void

FormItem Attributes

参数说明类型默认值
prop表单域 model 字段string
label标签文本string
label-width标签宽度string | number
required是否必填boolean
rules表单验证规则FormRule | FormRule[]
error表单域验证错误信息string
show-message是否显示校验错误信息booleantrue
size表单域尺寸'large' | 'default' | 'small'

FormRule

参数说明类型默认值
required是否必填boolean
message错误提示信息string
trigger触发校验的时机'blur' | 'change' | string | string[]
min最小值(字符串、数字、数组长度)number
max最大值(字符串、数字、数组长度)number
pattern正则表达式RegExp
validator自定义校验函数ValidatorFunction
type类型校验'string' | 'number' | 'boolean' | 'method' | 'regexp' | 'integer' | 'float' | 'array' | 'object' | 'enum' | 'date' | 'url' | 'hex' | 'email'