Skip to content

TIP

🚧 组件库更新通知 🚧:我们正在努力完善我们的组件库。

Form 表单

表单目前包含 输入框, 下拉选择, 开关 等用户输入的组件。 使用表单,您可以收集、验证和提交数据。

TIP

ps: 表单控件目前不全,待完善

基本用法

最基础的表单包括各种输入表单项,比如inputselectswitch等。(目前只开发了这三个 🤣) 在每个 from 组件中,需要使用 from-item 组件来包裹每个表单项,用于获取值与校验。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

对齐方式

通过 label-position 属性可以控制表单项的左右对齐方式。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

表单校验

通过 rules 属性可以设置表单项的校验规则。书写规则参考 async-validator

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

自定义校验规则

通过校验规则中的 validator 属性可以自定义校验规则。

TIP

🔨 施工中:我们的团队正在全力以赴,以确保为您提供最高质量的组件。请稍后再来查看这些组件的最新进展。

Form API

Props

NameDescriptionTypeDefault
model表单数据Record<string, any>-
rules校验规则FormRules-
disabled是否禁用表单booleanfalse
label-position标签位置enum- 'left' | 'top'| right'right
label-width标签宽度number-
label-suffix标签后缀string-
show-message是否显示提示booleantrue
hide-required-asterisk是否隐藏必填符号booleanfalse
required-asterisk-position必填符号位置enum-'left' | 'right'right

Events

NameDescriptionType
validate验证表单项校验后触发(prop: FormItemProps, isValid: boolean, message: string ) => void

Slots

NameDescriptionSub Component
default默认插槽FormItem

Expose

NameDescriptionType
validate校验表单项() => Promise<boolean>
validateField校验指定表单项(props?: string[],callback?:(isValid:boolean,invalidFields?: ValidateFieldsError)) => Promise<boolean>
resetFields重置表单项(props?: string[]) => void
clearValidate清除校验状态(props?: string[]) => void

FormItem API

Props

NameDescriptionTypeDefault
prop表单域 model 字段string-
label标签文本string-
label-width标签宽度,例如 '50px'string|number-
disabled是否禁用表单域booleanfalse
required是否必填,如不设置,则会根据校验规则自动生成booleanfalse
show-message是否显示校验错误信息booleantrue
error错误提示文案,如不设置,则会从校验规则的 message 属性中获取string-
rules校验规则FormItemRule[]-

Slots

NameDescriptionType
default默认插槽-
labellabel 插槽{label:string}
error错误提示文案插槽{error:string}

Expose

NameDescriptionType
validateStatus校验状态Ref<ValidateStatus> - 'success' | 'error' | 'validating' | 'init'
validateMessage校验信息Ref<string>
validate校验表单项(trigger: string,callback?: (valid: boolean,invalidFields?: ValidateFieldsError) => void) => Promise<boolean>
resetField重置表单项() => void
clearValidate清除校验结果() => void