From e5097dba9ff6c0f69cf453cbf011057dfe05d464 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Thu, 20 Feb 2020 10:09:25 +0800 Subject: [PATCH] docs(Form): add data structure of Rule --- src/field/README.md | 2 +- src/field/README.zh-CN.md | 2 +- src/form/README.md | 9 +++++++++ src/form/README.zh-CN.md | 13 ++++++++++++- 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/src/field/README.md b/src/field/README.md index 55e0da11f..0d847973c 100644 --- a/src/field/README.md +++ b/src/field/README.md @@ -242,7 +242,7 @@ Use `input-align` prop to align the input value | autosize | Textarea auto resize，can accpet an object,
e.g. { maxHeight: 100, minHeight: 50 } | *boolean \| object* | `false` | | left-icon | Left side icon name | *string* | - | | right-icon | Right side icon name | *string* | - | -| rules `v2.5.0` | Form validation rules | *object[]* | - | +| rules `v2.5.0` | Form validation rules | *Rule[]* | - | ### Events diff --git a/src/field/README.zh-CN.md b/src/field/README.zh-CN.md index 41f78687e..64bb26c37 100644 --- a/src/field/README.zh-CN.md +++ b/src/field/README.zh-CN.md @@ -261,7 +261,7 @@ export default { | autosize | 是否自适应内容高度，只对 textarea 有效，
可传入对象,如 { maxHeight: 100, minHeight: 50 }，
单位为`px` | *boolean \| object* | `false` | | left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - | | right-icon | 右侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - | -| rules `v2.5.0` | 表单校验规则，详见 [Form 组件](#/zh-CN/) | *object[]* | - | +| rules `v2.5.0` | 表单校验规则，详见 [Form 组件](#/zh-CN/) | *Rule[]* | - | ### Events diff --git a/src/form/README.md b/src/form/README.md index e944c4e89..7a462f55e 100644 --- a/src/form/README.md +++ b/src/form/README.md @@ -413,6 +413,15 @@ export default { | validate-first | Whether to stop the validation when a rule fails | *boolean* | `false` | | validate-trigger `v2.5.2` | When to validate the form，can be set to `onChange`、`onSubmit` | *string* | `onBlur` | +### Data Structure of Rule + +| Key | Description | Type | +|------|------|------| +| message | Error message | *string* | +| required | Whether to be a required field | *boolean* | +| validator | Custom validator | *() => boolean \| Promise* | +| trigger `v2.5.2` | When to validate the form，can be set to `onChange`、`onBlur` | *string* | + ### Events | Event | Description | Arguments | diff --git a/src/form/README.zh-CN.md b/src/form/README.zh-CN.md index 54375a894..742e5dd2b 100644 --- a/src/form/README.zh-CN.md +++ b/src/form/README.zh-CN.md @@ -443,10 +443,21 @@ export default { | error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | *string* | `left` | | colon | 是否在 label 后面添加冒号 | *boolean* | *false* | | validate-first | 是否在某一项校验不通过时停止校验 | *boolean* | `false` | -| validate-trigger `v2.5.2` | 表单校验触发时机，可选值为`onChange`、`onSubmit` | *string* | `onBlur` | +| validate-trigger `v2.5.2` | 表单校验触发时机，可选值为`onChange` | *string* | `onBlur` | > 表单项的 API 参见：[Field 组件](#/zh-CN/field#api) +### Rule 数据结构 + +使用 Field 的`rules`属性可以定义校验规则，可选属性如下: + +| 键名 | 说明 | 类型 | +|------|------|------| +| message | 错误提示文案 | *string* | +| required | 是否为必选字段 | *boolean* | +| validator | 自定义校验函数 | *() => boolean \| Promise* | +| trigger `v2.5.2` | 本项规则的校验触发时机，可选值为`onChange`、`onBlur` | *string* | + ### Events | 事件名 | 说明 | 回调参数 |