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 键可删除
拖拽上传
您可以将文件拖到某个区域进行上传。
手动上传
API
属性
名称 | 描述 | 类型 | 默认值 |
---|---|---|---|
action 必填 | 请求 URL。 | 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`,则上传将被中止。 | Function | — |
before-remove | 移除文件前的钩子函数,参数为文件和文件列表。如果返回 `false` 或返回一个被拒绝的 `Promise`,则移除将被中止。 | Function | — |
file-list / v-model:file-list | 默认已上传的文件。 | object | [] |
list-type | 文件列表的类型。 | 枚举 | 文本 |
auto-upload | 是否自动上传文件。 | boolean | true |
http-request | 覆盖默认的 xhr 行为,允许您实现自己的上传文件请求。 | Function | ajaxUpload 见 |
disabled | 是否禁用上传。 | boolean | false |
limit | 允许上传的最大数量。 | number | — |
插槽
名称 | 描述 | 类型 |
---|---|---|
default | 自定义默认内容。 | - |
trigger | 触发文件对话框的内容。 | - |
tip | 提示内容。 | - |
file | 缩略图模板的内容。 | object |
暴露
名称 | 描述 | 类型 |
---|---|---|
abort | 取消上传请求。 | 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]>
filename: string
file: File
headers: Headers | Record<string, string | number | null | undefined>
onError: (evt: UploadAjaxError) => void
onProgress: (evt: UploadProgressEvent) => void
onSuccess: (response: any) => void
withCredentials: boolean
}