ui/vant
1
0
Fork 0
mirror of https://github.com/youzan/vant.git synced 2025-10-13 14:33:41 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs(Uploader): optimize parameter description (#13498)

Browse Source 
Co-authored-by: neverland <jait.chen@foxmail.com>
This commit is contained in:
pany
2025-06-15 18:57:36 +08:00
committed by GitHub
parent ed8672e43d
commit 07983bf5bf
2 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/vant/src/uploader/README.md
View File

@@ -370,13 +370,20 @@ export default {
| preview-delete | Custom delete icon | - |
| preview-cover | Custom content that covers the image preview | _item: FileListItem_ |
### Parameters of before-read、after-read、before-delete
### Parameters of before-read、before-delete
| Attribute | Description | Type |
| --------- | ------------------------------------ | -------- |
| file | File object | _object_ |
| detail | Detail info, contains name and index | _object_ |
### Parameters of after-read
| Attribute | Description | Type |
| --- | --- | --- |
| file | Contains File object | _UploaderFileListItem \| UploaderFileListItem[]_ |
| detail | Detail info, contains name and index | _object_ |
### ResultType
| Value | Description |

11
packages/vant/src/uploader/README.zh-CN.md
View File

@@ -391,13 +391,22 @@ export default {
### 回调参数
before-read、after-read、before-delete 执行时会传递以下回调参数：
before-read、before-delete 执行时会传递以下回调参数：
| 参数名 | 说明 | 类型 |
| ------ | --------------------------------- | -------- |
| file | file 对象 | _object_ |
| detail | 额外信息，包含 name 和 index 字段 | _object_ |
### after-read 回调参数
after-read 执行时会传递以下回调参数：
| 参数名 | 说明 | 类型 |
| --- | --- | --- |
| file | 包含 file 对象 | _UploaderFileListItem \| UploaderFileListItem[]_ |
| detail | 额外信息，包含 name 和 index 字段 | _object_ |
### ResultType 可选值
`result-type` 字段表示文件读取结果的类型，上传大文件时，建议使用 file 类型，避免卡顿。