Uploader 文件上传

介绍

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

引入

  1. import Vue from 'vue';
  2. import { Uploader } from 'vant';
  3. Vue.use(Uploader);

代码演示

基础用法

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

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

文件预览

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

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

上传状态

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

  1. <van-uploader v-model="fileList" :after-read="afterRead" />
  1. export default {
  2. data() {
  3. return {
  4. fileList: [
  5. {
  6. url: 'https://img.yzcdn.cn/vant/leaf.jpg',
  7. status: 'uploading',
  8. message: '上传中...',
  9. },
  10. {
  11. url: 'https://img.yzcdn.cn/vant/tree.jpg',
  12. status: 'failed',
  13. message: '上传失败',
  14. },
  15. ],
  16. };
  17. },
  18. methods: {
  19. afterRead(file) {
  20. file.status = 'uploading';
  21. file.message = '上传中...';
  22. setTimeout(() => {
  23. file.status = 'failed';
  24. file.message = '上传失败';
  25. }, 1000);
  26. },
  27. },
  28. };

限制上传数量

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

  1. <van-uploader v-model="fileList" multiple :max-count="2" />
  1. export default {
  2. data() {
  3. return {
  4. fileList: [],
  5. };
  6. },
  7. };

限制上传大小

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

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

自定义上传样式

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

  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>

上传前置处理

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

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

禁用文件上传

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

  1. <van-uploader disabled />

API

Props

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

Events

事件名说明回调参数
oversize文件大小超过限制时触发after-read
click-preview点击预览图时触发after-read
close-preview关闭全屏图片预览时触发-
delete删除文件预览时触发after-read

Slots

名称说明参数
default自定义上传区域-
preview-cover v2.9.1自定义覆盖在预览区域上方的内容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 v2.5.6主动调起文件选择,由于浏览器安全限制,只有在用户触发操作的上下文中调用才有效--

样式变量

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

名称默认值描述
@uploader-size80px-
@uploader-icon-size24px-
@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-size14px-
@uploader-delete-background-colorrgba(0, 0, 0, 0.7)-
@uploader-file-background-color@background-color-
@uploader-file-icon-size20px-
@uploader-file-icon-color@gray-7-
@uploader-file-name-padding0 @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-colorfade(@gray-8, 88%)-
@uploader-mask-icon-size22px-
@uploader-mask-message-font-size@font-size-sm-
@uploader-mask-message-line-height@line-height-xs-
@uploader-loading-icon-size22px-
@uploader-loading-icon-color@white-
@uploader-disabled-opacity@disabled-opacity-

Uploader 文件上传 - 图1