Skip to content
On this page

NProForm

高级表单用于快速构建表单视图,使用 pro-form 需要使用 defineForm Functions。

高级表单基于对象的函数式编程(functional programming)思想。并将表单数据抽象为一个 JavaScript 对象,通过对这个对象进行操作和封装,让表单数据具有更好的可复用性和可维护性。

Props

名称类型默认值说明
instanceProFormInstance-组件的实例
gridbooleantrue是否开启栅格布局
colsnumber | ResponsiveDescription24显示的栅格数量
x-gapnumber | ResponsiveDescription0横向间隔槽
y-gapnumber | ResponsiveDescription0纵向间隔槽

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

Form Methods

名称类型说明
validate(paths?: string[]) => Promise<void>验证表项,传递 paths 过滤需要验证的参数
resetValidate(paths?: string[]) => void重置校验,传递 paths 过滤需要重置的参数
resetFields(paths?: string[]) => void重置表单数据为初始值,传递 paths 过滤需要重置的参数

Field Methods

名称类型说明
withConfig(config) => WithConfigField携带并返回新的配置
preventDefault() => WithConfigField将 label、rules 置空
preventRequired() => WithConfigFieldrules 中的 required 被删除
preventAutofill() => WithConfigField阻止浏览器自动填充
clone() => WithConfigField浅拷贝 field
cloneDeep() => WithConfigField深拷贝 field

Field Types

名称说明
date-picker日期选择器
auto-complete自动完成
cascader级联选择器
input输入框
input-number数字输入框
rate评分
time-picker时间选择器
mention提及
select选择器
switch开关
slider滑块
radio单选框
checkbox多选框
textarea多行输入框

Slots

名称类型说明
toolbars()工具栏内容,使用该插槽默认开启工具栏模式

Released under the MIT License.