Upload 上传
通过点击或拖拽上传文件。
基础用法
通过 slot 自定义上传按钮类型和文字。 设置 limit 和 on-exceed 来限制允许上传的最大数量,并指定超过限制时的方法。 此外,您可以在 before-remove 钩子中取消移除文件。
jpg/png 文件,且大小不超过 500KB。
- 按 delete 键可删除
- 按 delete 键可删除
覆盖前一个文件
设置 limit 和 on-exceed,当选择一个新文件时,自动替换前一个文件。
用户头像
使用 before-upload 钩子来限制上传文件的格式和大小。
照片墙
使用 list-type 属性来改变文件列表的样式。
按 delete 键可删除
按 delete 键可删除
按 delete 键可删除
按 delete 键可删除
按 delete 键可删除
按 delete 键可删除
按 delete 键可删除
按 delete 键可删除
自定义缩略图
使用 scoped-slot 去自定义缩略图模版。
带有缩略图的文件列表
jpg/png 文件,且大小不超过 500kb
按 delete 键可删除
按 delete 键可删除
手动控制文件列表
使用 on-change 钩子函数来控制文件列表。
jpg/png 文件,且大小不超过 500kb
- 按 delete 键可删除
- 按 delete 键可删除
拖拽上传
您可以将文件拖拽到特定区域以进行上传。
上传目录 2.13.1
通过 directory 属性支持目录上传。
启用后,只能选择目录,选择目录后,目录内的文件将被平铺。
手动上传
API
属性
| 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| action 必传 | 请求地址。 | string | # |
| headers | 设置上传的请求头部。 | object | — |
| method | 设置上传请求方法。 | string | post |
| multiple | 是否支持多选文件。 | boolean | false |
| data | 上传时附带的额外参数。 自 v2.3.13 起支持 Awaitable 数据和 Function。 | object / Function | {} |
| 名称 | 上传的文件字段名。 | string | file |
| with-credentials | 支持发送 cookie 凭证信息。 | boolean | false |
| show-file-list | 是否显示已上传文件列表。 | boolean | true |
| drag | 是否启用拖拽上传。 | boolean | false |
| accept | 接受上传的 文件类型,该属性在 thumbnail-mode === true 时无效。 | string | '' |
| crossorigin | 原生属性 crossorigin。 | 枚举 | — |
| on-preview | 点击文件列表中已上传文件时的钩子。 | Function | — |
| on-remove | 文件列表移除文件时的钩子。 | Function | — |
| on-success | 文件上传成功时的钩子。 | Function | — |
| on-error | 文件上传失败时的钩子。 | Function | — |
| on-progress | 文件上传时的钩子。 | Function | — |
| on-change | 文件状态改变时的钩子,添加文件、上传成功和上传失败时都会被调用。 | Function | — |
| on-exceed | 当超出限制时的钩子。 | Function | — |
| before-upload | 上传文件之前的钩子,参数为上传的文件,若返回 false 或者返回 Promise 且被 reject,则停止上传。 | Function | — |
| before-remove | 删除文件之前的钩子,参数为上传的文件和文件列表,若返回 false 或者返回 Promise 且被 reject,则停止删除。 | Function | — |
| file-list / v-model:file-list | 默认上传文件。 | array | [] |
| list-type | 文件列表类型。 | 枚举 | 文本 |
| auto-upload | 是否在选取文件后立即进行上传。 | boolean | true |
| http-request | 覆盖默认的 XHR 行为,允许自行实现上传文件的请求。 | Function | ajaxUpload 详情见 |
| disabled | 是否禁用上传。 | boolean | false |
| limit | 允许上传文件的最大数量。 | number | — |
| directory 2.13.1 | 是否支持上传目录。 启用后,只能选择目录,选择目录后,目录内的文件将被平铺。 | boolean | false |
插槽
| 名称 | 描述 | 类型 |
|---|---|---|
| default | 自定义默认内容。 | - |
| trigger | 触发文件选择框的内容。 | - |
| tip | 提示说明文字。 | - |
| file | 缩略图模板内容。 | object |
暴露
| 名称 | 描述 | 类型 |
|---|---|---|
| abort | 取消上传请求。 如果指定了 file,则取消对应的待上传文件;如果没有指定,则取消所有待上传文件。 | Function |
| submit | 手动上传文件列表。 | Function |
| clearFiles | 清空已上传的文件列表(该方法不支持在 before-upload 钩子中调用)。 | Function |
| handleStart | 手动选择文件。 | Function |
| handleRemove | 手动移除文件。 file 和 rawFile 已合并。 rawFile 将在 v2.2.0 中被移除。 | Function |
类型声明
显示声明
ts
type UploadFiles = UploadFile[]
type UploadUserFile = Omit<UploadFile, 'status' | 'uid'> &
Partial<Pick<UploadFile, 'status' | 'uid'>>
type UploadStatus = 'ready' | 'uploading' | 'success' | 'fail'
type Awaitable<T> = Promise<T> | T
type Mutable<T> = { -readonly [P in keyof T]: T[P] }
interface UploadFile {
name: string
percentage?: number
status: UploadStatus
size?: number
response?: unknown
uid: number
url?: string
raw?: UploadRawFile
}
interface UploadProgressEvent extends ProgressEvent {
percent: number
}
interface UploadRawFile extends File {
uid: number
isDirectory?: boolean
}
interface UploadRequestOptions {
action: string
method: string
data: Record<string, string | Blob | [string | Blob, string] | string[]>
filename: string
file: UploadRawFile
headers: Headers | Record<string, string | number | null | undefined>
onError: (evt: UploadAjaxError) => void
onProgress: (evt: UploadProgressEvent) => void
onSuccess: (response: any) => void
withCredentials: boolean
}