介绍
用于将本地的图片或文件上传至服务器,并在上传过程中展示预览图和上传进度。目前 Uploader 组件不包含将文件上传至服务器的接口逻辑,该步骤需要自行实现。
引入
代码演示
基础用法
文件上传完毕后会触发 `after-read` 回调函数,获取到对应的 `file` 对象。
文件预览
通过 `v-model` 可以绑定已经上传的文件列表,并展示文件列表的预览图。
上传状态
通过 `status` 属性可以标识上传状态,`uploading` 表示上传中,`failed` 表示上传失败,`done` 表示上传完成。
限制上传数量
通过 `max-count` 属性可以限制上传文件的数量,上传数量达到限制后,会自动隐藏上传区域。
限制上传大小
通过 `max-size` 属性可以限制上传文件的大小,超过大小的文件会被自动过滤,这些文件信息可以通过 `oversize` 事件获取。
如果需要针对不同类型的文件来作出不同的大小限制,可以在 `max-size` 属性中传入一个函数,在函数中通过 `file.type` 区分文件类型,返回 `true` 表示超出限制,`false` 表示未超出限制。
自定义上传样式
通过默认插槽可以自定义上传区域的样式。
自定义预览样式
通过 `preview-cover` 插槽可以自定义覆盖在预览区域上方的内容。
上传前置处理
通过传入 `beforeRead` 函数可以在上传前进行校验和处理,返回 `true` 表示校验通过,返回 `false` 表示校验失败。支持返回 `Promise` 对 file 对象进行自定义处理,例如压缩图片。
禁用文件上传
通过 `disabled` 属性禁用文件上传。
自定义单个图片预览
在 `v-model` 数组中设置单个预览图片属性,支持 `imageFit` `deletable` `previewSize` `beforeDelete`,从 2.12 版本开始支持。
API
Props
参数 | 说明 | 类型 | 默认值 | |
---|---|---|---|---|
v-model (fileList) | 已上传的文件列表 | FileListItem[] | - | |
accept | 允许上传的文件类型,[详细说明](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B) | string | image/* | |
name | 标识符,可以在回调函数的第二项参数中获取 | number 、 string | - | |
preview-size | 预览图和上传区域的尺寸,默认单位为 px | number 、 string | 80px | |
preview-image | 是否在上传完成后展示预览图 | boolean | true | |
preview-full-image | 是否在点击预览图后展示全屏图片预览 | boolean | true | |
preview-options v2.9.3 | 全屏图片预览的配置项,可选值见 [ImagePreview](https://youzan.github.io/vant/v2/#/zh-CN/image-preview) | object | - | |
multiple | 是否开启图片多选,部分安卓机型不支持 | boolean | false | |
disabled | 是否禁用文件上传 | boolean | false | |
readonly v2.12.26 | 是否将上传区域设置为只读状态 | boolean | false | |
deletable | 是否展示删除按钮 | boolean | true | |
show-upload v2.5.6 | 是否展示上传区域 | boolean | true | |
lazy-load v2.6.2 | 是否开启图片懒加载,须配合 [Lazyload](https://youzan.github.io/vant/v2/#/zh-CN/lazyload) 组件使用 | boolean | false | |
capture | 图片选取模式,可选值为 camera (直接调起摄像头) | string | - | |
after-read | 文件读取完成后的回调函数 | Function | - | |
before-read | 文件读取前的回调函数,返回 false 可终止文件读取,支持返回 Promise | Function | - | |
before-delete | 文件删除前的回调函数,返回 false 可终止文件读取,支持返回 Promise | Function | - | |
max-size v2.12.20 | 文件大小限制,单位为 byte | number 、 string 、 (file: File) => boolean | - | |
max-count | 文件上传数量限制 | number 、 string | - | |
result-type | 文件读取结果类型,可选值为 file text | string | dataUrl | |
upload-text | 上传区域文字提示 | string | - | |
image-fit | 预览图裁剪模式,可选值见 [Image](https://youzan.github.io/vant/v2/#/zh-CN/image) 组件 | string | cover | |
upload-icon v2.5.4 | 上传区域[图标名称](https://youzan.github.io/vant/v2/#/zh-CN/icon)或图片链接 | string | photograph |
> 注意:accept、capture 和 multiple 为浏览器 input 标签的原生属性,移动端各种机型对这些属性的支持程度有所差异,因此在不同机型和 WebView 下可能出现一些兼容性问题。
Events
事件名 | 说明 | 回调参数 | |
---|---|---|---|
oversize | 文件大小超过限制时触发 | 同 after-read | |
click-upload v2.12.26 | 点击上传区域时触发 | event: MouseEvent | |
click-preview | 点击预览图时触发 | 同 after-read | |
close-preview | 关闭全屏图片预览时触发 | - | |
delete | 删除文件预览时触发 | 同 after-read |
Slots
名称 | 说明 | 参数 | |
---|---|---|---|
default | 自定义上传区域 | - | |
preview-cover v2.9.1 | 自定义覆盖在预览区域上方的内容 | item: FileListItem |
回调参数
before-read、after-read、before-delete 执行时会传递以下回调参数:
参数名 | 说明 | 类型 | |
---|---|---|---|
file | file 对象 | object | |
detail | 额外信息,包含 name 和 index 字段 | object |
ResultType 可选值
`result-type` 字段表示文件读取结果的类型,上传大文件时,建议使用 file 类型,避免卡顿。
值 | 描述 | |
---|---|---|
file | 结果仅包含 File 对象 | |
text | 结果包含 File 对象,以及文件的文本内容 | |
dataUrl | 结果包含 File 对象,以及文件对应的 base64 编码 |
方法
通过 ref 可以获取到 Uploader 实例并调用实例方法,详见
。
方法名 | 说明 | 参数 | 返回值 | |
---|---|---|---|---|
closeImagePreview | 关闭全屏的图片预览 | - | - | |
chooseFile v2.5.6 | 主动调起文件选择,由于浏览器安全限制,只有在用户触发操作的上下文中调用才有效 | - | - |
样式变量
组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考
。
名称 | 默认值 | 描述 | |
---|---|---|---|
@uploader-size | 80px | - | |
@uploader-icon-size | 24px | - | |
@uploader-icon-color | @gray-4 | - | |
@uploader-text-color | @gray-6 | - | |
@uploader-text-font-size | @font-size-sm | - | |
@uploader-upload-background-color | @gray-1 | - | |
@uploader-upload-active-color | @active-color | - | |
@uploader-delete-color | @white | - | |
@uploader-delete-icon-size | 14px | - | |
@uploader-delete-background-color | rgba(0, 0, 0, 0.7) | - | |
@uploader-file-background-color | @background-color | - | |
@uploader-file-icon-size | 20px | - | |
@uploader-file-icon-color | @gray-7 | - | |
@uploader-file-name-padding | 0 @padding-base | - | |
@uploader-file-name-margin-top | @padding-xs | - | |
@uploader-file-name-font-size | @font-size-sm | - | |
@uploader-file-name-text-color | @gray-7 | - | |
@uploader-mask-background-color | fade(@gray-8, 88%) | - | |
@uploader-mask-icon-size | 22px | - | |
@uploader-mask-message-font-size | @font-size-sm | - | |
@uploader-mask-message-line-height | @line-height-xs | - | |
@uploader-loading-icon-size | 22px | - | |
@uploader-loading-icon-color | @white | - | |
@uploader-disabled-opacity | @disabled-opacity | - |
常见问题
Uploader 在部分安卓机型上无法上传图片?
Uploader 采用了 HTML 原生的 `
上传图片时出现浏览器刷新或卡顿现象?
这种现象一般是内存不足导致的,通常发生在旧机型上;上传一张较大的图片引起也引起此现象。
为了减少这种情况的出现,可以在上传图片前对图片进行压缩,压缩方法请参考上文中的提到的 `compressorjs` 库。
上传 HEIC/HEIF 格式的图片后无法展示?
目前 Chrome、Safari 等浏览器不支持展示 HEIC/HEIF 格式的图片,因此上传后无法在 Uploader 组件中进行预览。
HEIF格式的兼容性请参考
。
效果图: