使用示例
ykc-form
基础用法
参数 | 必填 | 说明 | 类型 | 可选值 | 默认值 |
model | 是 | 表单数据对象 | object | — | — |
rules | 否 | 表单验证规则 | object | — | — |
labelPosition | 否 | 表单域标签的位置 | string | right/left/top | top |
label-width | 否 | 表单域标签的宽度 | string | — | - |
showMessage | 否 | 是否显示校验错误信息 | boolean | — | true |
disabled | 否 | 是否禁用该表单内的所有组件 | boolean | — | false |
方法名 | 说明 | 参数 |
validate | 对整个表单进行校验的方法,参数为一个回调函数。该回调函数会在校验结束后被调用,并传入两个参数:是否校验成功和未通过校验的字段。若不传入回调函数,则会返回一个 promise | Function(callback: Function(boolean, object)) |
validateField | 对部分表单字段进行校验的方法 | Function(props: array / string, callback: Function(errorMessage: string)) |
resetFields | 对整个表单进行重置,将所有字段值重置为初始值并移除校验结果 | — |
clearValidate | 移除表单项的校验结果。传入待移除的表单项的 prop 属性或者 prop 组成的数组,如不传则移除整个表单的校验结果 | Function(props: array / string) |
事件名称 | 说明 | 回调参数 |
validate | 任一表单项被校验后触发 | 被校验的表单项 prop 值,校验是否通过,错误消息 |
参数 | 必填 | 说明 | 类型 | 可选值 | 默认值 |
prop | 否 | 表单域 model 字段,在使用 validate、resetFields 方法的情况下,该属性是必填的 | string | 传入 Form 组件的 model 中的字段 | — |
label | 是 | 标签文本 | string | — | — |
label-width | 否 | 表单域标签的宽度 | string | — | - |
required | 否 | 是否必填,如不设置,则会根据校验规则自动生成 | boolean | — | false |
rules | 否 | 表单验证规则 | object | — | — |
error | 否 | 表单域验证错误信息, 设置该值会使表单验证状态变为error,并显示该错误信息 | string | — | — |
showMessage | 否 | 是否显示校验错误信息 | boolean | — | true |
方法名 | 说明 | 参数 |
resetField | 对该表单项进行重置,将其值重置为初始值并移除校验结果 | — |
clearValidate | 移除该表单项的校验结果 | - |