taolin/docs_vue2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update uploader doc, add invalid event (#1)

Browse Source 
Co-authored-by: r7r10t32 <382141176@baidu.com>
This commit is contained in:
zhaoyichen 2020-09-02 12:02:03 +08:00 committed by GitHub
parent e9d5c23f68
commit 93c8b00d53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
one/docs/components/uploader.md
View File

@ -227,6 +227,7 @@
| `remove` | [^event-remove] |
| `success` | 上传成功时触发，回调参数与 `remove` 事件的回调参数相同。 |
| `failure` | 上传失败时触发，回调参数与 `remove` 事件的回调参数相同。 |
| `invalid` | [^event-invalid] |
| `statuschange` | [^event-statuschange] |
| `progress` | [^event-progress] |
@ -261,6 +262,38 @@
+++
^^^
^^^event-invalid
文件校验失败时触发，回调参数为 `(invalidInfo: Object)`。
+++参数字段详情
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `file` | `Object` | 没有通过校验的文件信息，与 `remove` 事件的回调参数中的 `file` 相同。如果校验失败的原因是选择的文件数量超过最大数量 `max-count` 限制，则这个字段为空。 |
| `errors` | `Array<Object>` | 包含该文件所有校验错误信息的数组，数组的每一项是包含校验失败信息的对象。 |
+++
+++校验失败信息字段详情
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `type` | `string` | 校验失败的类型，类型可从 `Uploader` 组件 `export` 的 `(errors: Object)` 对象获取。 |
| `value` | `number|string|Object` | 没有通过校验的值，根绝 `type` 的不同有不同的类型。 |
| `message` | `string` | 检验失败的提示信息。 |
+++
+++校验失败信息 type 和 value 对应关系
| 失败类型 | 失败描述 | value 的类型 | value 描述 |
| -- | -- | -- | -- |
| `TYPE_INVALID` | 文件类型校验失败。 | `string` | 文件名称。 |
| `SIZE_INVALID` | 文件大小校验失败。 | `number` | 文件大小。 |
| `TOO_MANY_FILES` | 选择的文件数量超过最大数量 `max-count` 限制。 | `number` | 已选择的文件数量。 |
| `CUSTOM_INVALID` | `validator` 自定义校验失败。 | `Object` | 文件对象。 |
+++
^^^
^^^event-statuschange
在所有文件总的状态发生变化时触发，回调参数为组件整体的状态 `(status: string)`。