Form - 高级表单
Form 在 Antd Form 的基础上增加了一些语法糖,快速开发表单。
API
Form 是对 Antd Form 的再封装,除了继承 Antd Form 的 API 还支持下面属性和方法。
Form Props
属性 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
layout | 布局 | string | 'horizontal' / 'vertical' / 'inline' | 'vertical' |
initialValues | 默认值 | object | - | - |
submitOnReset | 重置后是否执行 submit | boolean | - | false |
grid | 开启 grid 模式 | boolean | - | false |
rowProps | Antd Row 的 props | RowProps | - | |
transform | onFinish 触发前,可以对 values 做修改 | (values) => values | - | - |
Form Emits
事件 | 说明 | 回调参数 |
---|---|---|
onSubmit | 提交时触发 | Function(e: Event | { __MARK__: 'submit' }) |
onFinish | 提交并且校验通过的回调 | Function(values) |
onFormRef | 提交并且校验通过的回调 | Function(values) |
onFinishFailed | 提交并且校验通过的回调 | Function(values) |
onReset | 重置表单回调 | Function(values) |
onValuesChange | 数据变化时回调 | Function(values) |
Form Expose
属性/方法 | 说明 | 类型 |
---|---|---|
formInstanceRef | Form 实例 | Ref<object> |
model | 提交时触发 | Ref<object> |
formProps | 提交并且校验通过的回调 | Ref<object> |
setModelValue | 重置表单回调 | (values) |
getModelValue | 重置表单回调 | (values) |
updateModelValue | 重置表单回调 | (values) |
deleteModelValue | 重置表单回调 | (values) |
submit | 重置表单回调 | (values) |
validate | 重置表单回调 | (values) |
resetFields | 重置表单回调 | (values) |