diff --git a/packages/core/useUpload/index.md b/packages/core/useUpload/index.md index e69de29..f5a28ae 100644 --- a/packages/core/useUpload/index.md +++ b/packages/core/useUpload/index.md @@ -0,0 +1,126 @@ +# UseUpload + +upload file + +## Example + +### Basic Usage + +```ts + +``` + +```html + +``` + +### Limit file types + +```ts + +``` + +```html + +``` + +### Limit file size + +```ts + +``` + +```html + +``` + +### Limit upload count + +```ts + +``` + +```html + +``` + +## Types + +### UseUploadOptions + +| Name | Type | Default | Require | Description | +| -------- | -------- | -------- | ------- | -------------------- | +| url | _number_ | - | [x] | 上传文件的服务器地址 | +| accept | _string_ | '' | [ ] | 允许上传的文件类型 | +| maxSize | _number_ | Infinity | [ ] | 最大可上传的文件大小 | +| maxCount | _number_ | Infinity | [ ] | 最多可上传的文件数量 | + +### UseUploadReturn + +| Name | Type | Description | +| ------ | ------------------------------------------------ | ------------------ | +| files | _Ref\_ | 当前添加的文件列表 | +| append | _(file: File \| File[]) => Promise_ | 添加文件方法 | +| upload | _(index: number \| number[]) => void_ | 上传方法 | +| remove | _(index: number \| number[]) => UseUploadFile[]_ | 删除文件方法 | + +### UseUploadFile + +| Name | Type | Description | +| ------ | ------------------------------------------------ | ---------------------------- | +| file | _File_ | 文件源数据 | +| name | _string_ | 文件名 | +| ext | _string_ | 扩展名 | +| data | _string \| ArrayBuffer_ | base64数据,用于图片文件预览 | +| status | _'ready' \| 'uploading' \| 'success' \| 'error'_ | 上传状态 | +| error | _Error_ | 上传失败原因 | diff --git a/packages/core/useUpload/index.zh-CN.md b/packages/core/useUpload/index.zh-CN.md index 6d8e8ed..01e14a7 100644 --- a/packages/core/useUpload/index.zh-CN.md +++ b/packages/core/useUpload/index.zh-CN.md @@ -1,3 +1,126 @@ # UseUpload -上传文件 \ No newline at end of file +上传文件 + +## 用法 + +### 基础用法 + +```ts + +``` + +```html + +``` + +### 设置允许上传的文件类型 + +```ts + +``` + +```html + +``` + +### 限制上传文件大小 + +```ts + +``` + +```html + +``` + +### 限制上传文件数量 + +```ts + +``` + +```html + +``` + +## 类型定义 + +### UseUploadOptions + +| 名称 | 类型 | 默认值 | 是否必传 | 说明 | +| -------- | -------- | -------- | -------- | -------------------- | +| url | _number_ | - | [x] | 上传文件的服务器地址 | +| accept | _string_ | '' | [ ] | 允许上传的文件类型 | +| maxSize | _number_ | Infinity | [ ] | 最大可上传的文件大小 | +| maxCount | _number_ | Infinity | [ ] | 最多可上传的文件数量 | + +### UseUploadReturn + +| 名称 | 类型 | 说明 | +| ------ | ------------------------------------------------ | ------------------ | +| files | _Ref\_ | 当前添加的文件列表 | +| append | _(file: File \| File[]) => Promise_ | 添加文件方法 | +| upload | _(index: number \| number[]) => void_ | 上传方法 | +| remove | _(index: number \| number[]) => UseUploadFile[]_ | 删除文件方法 | + +### UseUploadFile + +| 名称 | 类型 | 说明 | +| ------ | ------------------------------------------------ | ---------------------------- | +| file | _File_ | 文件源数据 | +| name | _string_ | 文件名 | +| ext | _string_ | 扩展名 | +| data | _string \| ArrayBuffer_ | base64数据,用于图片文件预览 | +| status | _'ready' \| 'uploading' \| 'success' \| 'error'_ | 上传状态 | +| error | _Error_ | 上传失败原因 |