Skip to content

Form 表单

动态配置式表单组件,支持模板式和函数式两种用法。

基础用法

通过配置快速生成表单。

动态组件

支持使用 compType 配置不同的表单组件类型,compProps 传递组件属性。

插槽

通过 prop 对应插槽名称。

函数式用法

使用 useEplForm 创建表单组件。

API

属性

属性名说明类型默认值
modelValue / v-model表单数据对象object
items表单项配置TFormItem[][]
rules表单验证规则FormRules

TFormItem 配置

属性名说明类型
label标签文本string
prop字段名string
placeholder占位文本string
span栅格占据的列数number
hidden是否隐藏boolean
compType组件类型string | VNode | Component
compProps组件属性object

方法

方法名说明类型
validate验证表单() => Promise<boolean>
resetFields重置表单() => void

useEplForm

函数式创建表单。

ts
const { formComp, validate, resetFields } = useEplForm({
  modelValue,
  rules,
  items,
});

参数

参数名说明类型
modelValue表单数据对象Ref<object>
rules表单验证规则FormRules
items表单项配置TFormItem[] | ComputedRef<TFormItem[]>

返回值

属性名说明类型
formComp表单组件Component
validate验证表单方法() => Promise<boolean>
resetFields重置表单方法() => void