Upload 上传

通过点击或者拖拽上传文件。

基础用法

覆盖前一个文件

用户头像

before-upload 钩子中限制用户上传文件的格式和大小。

照片墙

使用 list-type 属性来设定文件列表的样式。

自定义缩略图

使用 scoped-slot 属性来改变默认的缩略图模板样式。

图片列表缩略图

上传文件列表控制

通过 on-change 钩子函数来对上传文件的列表进行控制。

拖拽上传

你可以将文件拖拽到特定区域以进行上传。

手动上传

上传 API

属性

名称描述类型默认值必填
action请求 URLstring
headers设置上传的请求头部Headers | Record<string, any>
method设置上传请求方法string'post'
multiple是否支持多选文件booleanfalse
data上传时附带的额外参数Record<string, any>
name上传的文件字段名string'file'
with-credentials支持发送 cookie 凭证信息booleanfalse
show-file-list是否显示已上传文件列表booleantrue
drag是否启用拖拽上传booleanfalse
accept接受上传的文件类型(thumbnail-mode 模式下此参数无效)string
on-preview点击文件列表中已上传的文件时的钩子(uploadFile: UploadFile) => void
on-remove文件列表移除文件时的钩子(uploadFile: UploadFile, uploadFiles: UploadFiles) => void
on-success文件上传成功时的钩子(response: any, uploadFile: UploadFile, uploadFiles: UploadFiles) => void
on-error文件上传失败时的钩子(error: Error, uploadFile: UploadFile, uploadFiles: UploadFiles) => void
on-progress文件上传时的钩子(evt: UploadProgressEvent, uploadFile: UploadFile, uploadFiles: UploadFiles) => void
on-change文件状态改变时的钩子,添加文件、上传成功和上传失败时都会被调用(uploadFile: UploadFile, uploadFiles: UploadFiles) => void
on-exceed当超出限制时,执行的钩子函数(files: File[], uploadFiles: UploadFiles) => void
before-upload上传文件之前的钩子,参数为上传的文件, 若返回false或者返回 Promise 且被 reject,则停止上传。(rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>
before-remove删除文件之前的钩子,参数为上传的文件和文件列表, 若返回 false 或者返回 Promise 且被 reject,则停止删除。(uploadFile: UploadFile, uploadFiles: UploadFiles) => Awaitable<boolean>
file-list / v-model:file-list默认上传文件UploadUserFile[][]
list-type文件列表的类型'text' | 'picture' | 'picture-card''text'
auto-upload是否自动上传文件booleantrue
http-request覆盖默认的 Xhr 行为,允许自行实现上传文件的请求(options: UploadRequestOptions) => XMLHttpRequest | Promise<unknown>
disabled是否禁用上传booleanfalse
limit允许上传文件的最大数量number

插槽

名称描述类型
default自定义默认内容-
trigger触发文件选择框的内容-
tip提示说明文字-
file缩略图模板的内容{ file: UploadFile }

外部方法

名称描述类型
abort取消上传请求(file: UploadFile) => void
submit手动上传文件列表() => void
clearFiles清空已上传的文件列表(该方法不支持在 before-upload 中调用)(status?: Array<"ready" | "uploading" | "success" | "fail">) => void
handleStart手动选择文件(rawFile: UploadRawFile) => void
handleRemove手动移除文件。 filerawFile 已被合并。 rawFile 将在 v2.2.0 中移除(file: UploadFile | UploadRawFile, rawFile?: UploadRawFile) => void

源代码

组件文档

贡献者