naive-ui/demo/documentation/components/form/zhCN/index.md

表单 Form

收集、验证信息

演示

inline
custom-rule
top
left

Props

Form Props

名称	类型	默认值	介绍
inline	boolean	false
label-width	number	null	标签的宽度，在 label-placement 是 'left' 的时候可能会有用
label-align	'left' | 'right'	'left'	标签的文本对齐方式
label-placement	'left' | 'top'	'top'
model	object		获取表项中收集到的值的对象
rules	type FormRules = { [itemValidatePath: string]: FormItemRule | Array<FormItemRule> | FormRules }	{}	验证表项的规则
show-require-mark	boolean	true	在表项是必填的时候是不是展示星号

FormItemRule Type

属性	类型	介绍
required	boolean
validator	(rule: FormItemRule, value: any) => boolean | Error
trigger	string | Array<string>
message	string

Form Item Props

名称	类型	默认值	介绍
label	string	null
label-width	number	null	如果没有被设定，使用外层表单的 label-align
label-style	object	{}
label-align	'left' | 'right'	null	标签的文本对齐方式。如果没有被设定，使用外层表单的 label-align
label-placement	'left' | 'top'	null	如果没有被设定，使用外层表单的 label-placement
path	string	null	将值收集到外层表单 model 对象的路径
rule-path	string	null	从外层表单的 rules 对象获取规则的路径。如果没有设定，使用表项的 path 代替。
required	boolean	false	是否展示必填的星号。注意：一个 required 的规则比这个属性有更高的优先级 & 这个属性不会影响表单的验证。验证完全依赖于规则。
show-require-mark	boolean	true	在表项是必填的时候是不是展示星号。如果没有被设定，使用外层表单的 show-require-mark
rule	FormItemRule | Array<FormItemRule>	null	验证表项的规则，它会被通过 rule-path 从外层表单获取的规则合并来作为表项的验证规则。推荐还是在外层表单设置所有规则。
first	boolean	false	是否只展示首个出错信息。

Form Item Row Props

接受 Form Item & Row 所有的 Props。

Form Item Col Props

接受 Form Item & Col 所有的 Props。

Methods

Form Methods

验证只会在有 `path` 属性的表项上执行 验证会使用 `path` 从 `model` 获取收集到的值，使用 `path` 或者 `rule-path`（如果声明了）去获取验证规则 验证将会在合法表项的所有规则上进行，不管规则的 trigger 是什么

名称	类型	介绍
validate	(validateCallback?: (errors?: Array<ValidationError>) => any) => Promise<void>	验证表单。Promise rejection 的返回值类型是 Array<ValidationError>。
clearValidationEffect	() => void

Form Item, Form Item Row, Form Item Col Methods

名称	类型	介绍
validate	(trigger?: string, validateCallback?: (errors?: Array<ValidationError>) => any, options?: AsyncValidatorOptions) => Promise<void>	验证表项，Promise rejection 的返回值类型是 Array<ValidationError>。如果不传 trigger，这一个表项全部的 Rules 都会被使用。
clearValidationEffect	() => void

关于 AsyncValidatorOptions，参考 async-validator。

Slots

Form, Form Item, Form Item Row, Form Item Col Methods

名称	参数	介绍
default	()