Skip to content

ProForm

ProForm 是一个基于 ProBaseForm 的高级表单组件,支持表单工具栏(提交、重置按钮)的配置,提供表单验证、重置字段等常用功能,可通过插槽自定义工具栏内容。

基础用法

请输入姓名
Please Input
{}
Default
expand codecollapse code

表单校验

Please Input
Please Input
{}
Default
expand codecollapse code

栅格表单

Please Input
Please Input
Please Select
{}
Default
expand codecollapse code

属性 (Props)

继承 ProBaseFormProps

参数类型默认值描述
toolbarProFormToolBar-表单工具栏配置参考下面 toolbar,默认值按表单类型自动设置

更多参数请参考 n-formn-grid 的属性。

事件 (Emits)

事件名参数描述
submit(isValid: boolean) => void提交表单时触发
reset() => void重置表单时触发

插槽 (Slots)

插槽名称参数描述
toolbar-自定义工具栏内容。如果提供了该插槽,将完全替换默认的搜索、重置和展开/收起按钮。
footer{ overflow: boolean } - 表单是否处于折叠状态。自定义表单底部内容,默认包含工具栏。
default-表单的主体内容,继承自 ProBaseForm,用于自定义表单字段的布局与显示。

方法 (Expose)

方法名参数描述
validate(callback?: FormValidateCallback, shouldRuleBeApplied?: ShouldRuleBeApplied) => void还原到未校验的状态
restoreValidation() => void验证表单,Promise rejection 的返回值的是类型 Array<FormValidationError>
resetFields() => void对整个表单进行重置,将所有字段值重置为初始值并移除校验结果

Columns 配置

参考 ProBaseFormColumn

Toolbar 配置

参数类型默认值描述
justify'start' | 'end' | 'center' | 'space-around' | 'space-between' | 'space-evenly'start布局对齐方式
submitbooleantrue提交按钮
submitTextstring'提交'提交按钮的文本
submitPropsButtonProps提交按钮的属性,支持 Naive UI 按钮的所有属性
resetbooleantrue重设按钮
resetTextstring'重置'默认 i18n 文本
resetPropsButtonProps-重设按钮的属性, 支持 Naive UI 按钮的所有属性