Uploader 文件上传

介绍

用于将本地的图片或文件上传至服务器,并在上传过程中展示预览图和上传进度。目前 Uploader 组件不包含将文件上传至服务器的接口逻辑,该步骤需要自行实现。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { Uploader } from 'vant';
  3. const app = createApp();
  4. app.use(Uploader);

代码演示

基础用法

文件上传完毕后会触发 after-read 回调函数,获取到对应的 file 对象。

  1. <van-uploader :after-read="afterRead" />
  1. export default {
  2. setup() {
  3. const afterRead = (file) => {
  4. // 此时可以自行将文件上传至服务器
  5. console.log(file);
  6. };
  7. return {
  8. afterRead,
  9. };
  10. },
  11. };

文件预览

通过 v-model 可以绑定已经上传的文件列表,并展示文件列表的预览图。

  1. <van-uploader v-model="fileList" multiple />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const fileList = ref([
  5. { url: 'https://fastly.jsdelivr.net/npm/@vant/assets/leaf.jpeg' },
  6. // Uploader 根据文件后缀来判断是否为图片文件
  7. // 如果图片 URL 中不包含类型信息,可以添加 isImage 标记来声明
  8. { url: 'https://cloud-image', isImage: true },
  9. ]);
  10. return {
  11. fileList,
  12. };
  13. },
  14. };

上传状态

通过 status 属性可以标识上传状态,uploading 表示上传中,failed 表示上传失败,done 表示上传完成。

  1. <van-uploader v-model="fileList" :after-read="afterRead" />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const fileList = ref([
  5. {
  6. url: 'https://fastly.jsdelivr.net/npm/@vant/assets/leaf.jpeg',
  7. status: 'uploading',
  8. message: '上传中...',
  9. },
  10. {
  11. url: 'https://fastly.jsdelivr.net/npm/@vant/assets/tree.jpeg',
  12. status: 'failed',
  13. message: '上传失败',
  14. },
  15. ]);
  16. const afterRead = (file) => {
  17. file.status = 'uploading';
  18. file.message = '上传中...';
  19. setTimeout(() => {
  20. file.status = 'failed';
  21. file.message = '上传失败';
  22. }, 1000);
  23. };
  24. return {
  25. fileList,
  26. afterRead,
  27. };
  28. },
  29. };

限制上传数量

通过 max-count 属性可以限制上传文件的数量,上传数量达到限制后,会自动隐藏上传区域。

  1. <van-uploader v-model="fileList" multiple :max-count="2" />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const fileList = ref([]);
  5. return {
  6. fileList,
  7. };
  8. },
  9. };

限制上传大小

通过 max-size 属性可以限制上传文件的大小,超过大小的文件会被自动过滤,这些文件信息可以通过 oversize 事件获取。

  1. <van-uploader multiple :max-size="500 * 1024" @oversize="onOversize" />
  1. import { Toast } from 'vant';
  2. export default {
  3. setup() {
  4. const onOversize = (file) => {
  5. console.log(file);
  6. Toast('文件大小不能超过 500kb');
  7. };
  8. return {
  9. onOversize,
  10. };
  11. },
  12. };

如果需要针对不同类型的文件来作出不同的大小限制,可以在 max-size 属性中传入一个函数,在函数中通过 file.type 区分文件类型,返回 true 表示超出限制,false 表示未超出限制。

  1. <van-uploader multiple :max-size="isOverSize" />
  1. import { Toast } from 'vant';
  2. export default {
  3. setup() {
  4. const isOverSize = (file) => {
  5. const maxSize = file.type === 'image/jpeg' ? 500 * 1024 : 1000 * 1024;
  6. return file.size >= maxSize;
  7. };
  8. return {
  9. isOverSize,
  10. };
  11. },
  12. };

自定义上传样式

通过默认插槽可以自定义上传区域的样式。

  1. <van-uploader>
  2. <van-button icon="plus" type="primary">上传文件</van-button>
  3. </van-uploader>

自定义预览样式

通过 preview-cover 插槽可以自定义覆盖在预览区域上方的内容。

  1. <van-uploader v-model="fileList">
  2. <template #preview-cover="{ file }">
  3. <div class="preview-cover van-ellipsis">{{ file.name }}</div>
  4. </template>
  5. </van-uploader>
  6. <style>
  7. .preview-cover {
  8. position: absolute;
  9. bottom: 0;
  10. box-sizing: border-box;
  11. width: 100%;
  12. padding: 4px;
  13. color: #fff;
  14. font-size: 12px;
  15. text-align: center;
  16. background: rgba(0, 0, 0, 0.3);
  17. }
  18. </style>

自定义预览大小

通过 preview-size 属性定义预览图和上传区域的大小。

  1. <!-- 不指定单位,默认为 px -->
  2. <van-uploader v-model="fileList" preview-size="60" />
  3. <!-- 指定单位,支持 rem, vh, vw -->
  4. <van-uploader v-model="fileList" preview-size="5rem" />

preview-size 设置为数组格式,可以分别设置宽高。数组第一项对应宽度,数组第二项对应高度。

  1. <van-uploader v-model="fileList" :preview-size="[60, 40]" />

上传前置处理

通过传入 beforeRead 函数可以在上传前进行校验和处理,返回 true 表示校验通过,返回 false 表示校验失败。支持返回 Promise 对 file 对象进行自定义处理,例如压缩图片。

  1. <van-uploader :before-read="beforeRead" />
  1. import { Toast } from 'vant';
  2. export default {
  3. setup() {
  4. // 返回布尔值
  5. const beforeRead = (file) => {
  6. if (file.type !== 'image/jpeg') {
  7. Toast('请上传 jpg 格式图片');
  8. return false;
  9. }
  10. return true;
  11. };
  12. // 返回 Promise
  13. const asyncBeforeRead = (file) =>
  14. new Promise((resolve, reject) => {
  15. if (file.type !== 'image/jpeg') {
  16. Toast('请上传 jpg 格式图片');
  17. reject();
  18. } else {
  19. const img = new File(['foo'], 'bar.jpg', {
  20. type: 'image/jpeg',
  21. });
  22. resolve(img);
  23. }
  24. });
  25. return {
  26. beforeRead,
  27. asyncBeforeRead,
  28. };
  29. },
  30. };

禁用文件上传

通过 disabled 属性禁用文件上传。

  1. <van-uploader disabled />

自定义单个图片预览

v-model 数组中设置单个预览图片属性,支持 imageFit deletable previewSize beforeDelete

  1. <van-uploader v-model="fileList" :deletable="false" />
  1. import { ref } from 'vue';
  2. import { Toast } from 'vant';
  3. export default {
  4. setup() {
  5. const fileList = ref([
  6. {
  7. url: 'https://fastly.jsdelivr.net/npm/@vant/assets/sand.jpeg',
  8. deletable: true,
  9. beforeDelete: () => {
  10. Toast('删除前置处理');
  11. },
  12. },
  13. {
  14. url: 'https://fastly.jsdelivr.net/npm/@vant/assets/tree.jpeg',
  15. imageFit: 'contain',
  16. },
  17. ]);
  18. return { fileList };
  19. },
  20. };

API

Props

参数说明类型默认值
v-model已上传的文件列表FileListItem[]-
accept允许上传的文件类型,详细说明stringimage/*
name标识符,通常为一个唯一的字符串或数字,可以在回调函数的第二项参数中获取number | string-
preview-size预览图和上传区域的尺寸,默认单位为 pxnumber | string | Array80px
preview-image是否在上传完成后展示预览图booleantrue
preview-full-image是否在点击预览图后展示全屏图片预览booleantrue
preview-options全屏图片预览的配置项,可选值见 ImagePreviewobject-
multiple是否开启图片多选,部分安卓机型不支持booleanfalse
disabled是否禁用文件上传booleanfalse
readonly v3.1.5是否将上传区域设置为只读状态booleanfalse
deletable是否展示删除按钮booleantrue
show-upload是否展示上传区域booleantrue
lazy-load是否开启图片懒加载,须配合 Lazyload 组件使用booleanfalse
capture图片选取模式,可选值为 camera (直接调起摄像头)string-
after-read文件读取完成后的回调函数Function-
before-read文件读取前的回调函数,返回 false 可终止文件读取,
支持返回 Promise
Function-
before-delete文件删除前的回调函数,返回 false 可终止文件读取,
支持返回 Promise
Function-
max-size v3.0.17文件大小限制,单位为 bytenumber | string | (file: File) => booleanInfinity
max-count文件上传数量限制number | stringInfinity
result-type文件读取结果类型,可选值为 file textstringdataUrl
upload-text上传区域文字提示string-
image-fit预览图裁剪模式,可选值见 Image 组件stringcover
upload-icon上传区域图标名称或图片链接,等同于 Icon 组件的 name 属性stringphotograph

注意:accept、capture 和 multiple 为浏览器 input 标签的原生属性,移动端各种机型对这些属性的支持程度有所差异,因此在不同机型和 WebView 下可能出现一些兼容性问题。

Events

事件名说明回调参数
oversize文件大小超过限制时触发after-read
click-upload v3.1.5点击上传区域时触发event: MouseEvent
click-preview点击预览图时触发after-read
close-preview关闭全屏图片预览时触发-
delete删除文件预览时触发after-read

Slots

名称说明参数
default自定义上传区域-
preview-delete v3.5.0自定义删除按钮-
preview-cover自定义覆盖在预览区域上方的内容item: FileListItem

回调参数

before-read、after-read、before-delete 执行时会传递以下回调参数:

参数名说明类型
filefile 对象object
detail额外信息,包含 name 和 index 字段object

ResultType 可选值

result-type 字段表示文件读取结果的类型,上传大文件时,建议使用 file 类型,避免卡顿。

描述
file结果仅包含 File 对象
text结果包含 File 对象,以及文件的文本内容
dataUrl结果包含 File 对象,以及文件对应的 base64 编码

方法

通过 ref 可以获取到 Uploader 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
closeImagePreview关闭全屏的图片预览--
chooseFile主动调起文件选择,由于浏览器安全限制,只有在用户触发操作的上下文中调用才有效--

类型定义

组件导出以下类型定义:

  1. import type {
  2. UploaderProps,
  3. UploaderInstance,
  4. UploaderResultType,
  5. UploaderFileListItem,
  6. } from 'vant';

UploaderInstance 是组件实例的类型,用法如下:

  1. import { ref } from 'vue';
  2. import type { UploaderInstance } from 'vant';
  3. const uploaderRef = ref<UploaderInstance>();
  4. uploaderRef.value?.chooseFile();

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-uploader-size80px-
—van-uploader-icon-size24px-
—van-uploader-icon-colorvar(—van-gray-4)-
—van-uploader-text-colorvar(—van-text-color-2)-
—van-uploader-text-font-sizevar(—van-font-size-sm)-
—van-uploader-upload-background-colorvar(—van-gray-1)-
—van-uploader-upload-active-colorvar(—van-active-color)-
—van-uploader-delete-colorvar(—van-white)-
—van-uploader-delete-icon-size14px-
—van-uploader-delete-background-colorrgba(0, 0, 0, 0.7)-
—van-uploader-file-background-colorvar(—van-background-color)-
—van-uploader-file-icon-size20px-
—van-uploader-file-icon-colorvar(—van-gray-7)-
—van-uploader-file-name-padding0 var(—van-padding-base)-
—van-uploader-file-name-margin-topvar(—van-padding-xs)-
—van-uploader-file-name-font-sizevar(—van-font-size-sm)-
—van-uploader-file-name-text-colorvar(—van-gray-7)-
—van-uploader-mask-text-colorvar(—van-white)-
—van-uploader-mask-background-colorfade(var(—van-gray-8), 88%)-
—van-uploader-mask-icon-size22px-
—van-uploader-mask-message-font-sizevar(—van-font-size-sm)-
—van-uploader-mask-message-line-heightvar(—van-line-height-xs)-
—van-uploader-loading-icon-size22px-
—van-uploader-loading-icon-colorvar(—van-white)-
—van-uploader-disabled-opacityvar(—van-disabled-opacity)-

常见问题

Uploader 在部分安卓机型上无法上传图片?

Uploader 采用了 HTML 原生的 <input type="file /> 标签进行上传,能否上传取决于当前系统和浏览器的兼容性。当遇到无法上传的问题时,一般有以下几种情况:

  1. 遇到了安卓 App WebView 的兼容性问题,需要在安卓原生代码中进行兼容,可以参考此文章
  2. 图片格式不正确,在当前系统/浏览器中无法识别,比如 webpheic 格式。
  3. 其他浏览器兼容性问题。

拍照上传的图片被旋转 90 度?

部分手机在拍照上传时会出现图片被旋转 90 度的问题,这个问题可以通过 compressorjs 或其他开源库进行处理。

compressorjs 是一个开源的图片处理库,提供了图片压缩、图片旋转等能力。

示例

使用 compressorjs 进行处理的示例代码如下:

  1. <van-uploader :before-read="beforeRead" />
  1. import Compressor from 'compressorjs';
  2. export default {
  3. setup() {
  4. const beforeRead = (file) =>
  5. new Promise((resolve) => {
  6. // compressorjs 默认开启 checkOrientation 选项
  7. // 会将图片修正为正确方向
  8. new Compressor(file, {
  9. success: resolve,
  10. error(err) {
  11. console.log(err.message);
  12. },
  13. });
  14. });
  15. return {
  16. beforeRead,
  17. };
  18. },
  19. };

上传图片时出现浏览器刷新或卡顿现象?

这种现象一般是内存不足导致的,通常发生在旧机型上;上传一张较大的图片引起也引起此现象。

为了减少这种情况的出现,可以在上传图片前对图片进行压缩,压缩方法请参考上文中提到的 compressorjs 库。

上传 HEIC/HEIF 格式的图片后无法展示?

目前 Chrome、Safari 等浏览器不支持展示 HEIC/HEIF 格式的图片,因此上传后无法在 Uploader 组件中进行预览。

[HEIF] 格式的兼容性请参考 caniuse

Uploader 文件上传 - 图1