引入

import Vue from 'vue';
import { Uploader } from 'vant';

Vue.use(Uploader);

代码演示

基础用法

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

<van-uploader :after-read="afterRead" />

export default {
  methods: {
    afterRead(file) {
      // 此时可以自行将文件上传至服务器
      console.log(file);
    }
  }
};

图片预览

通过v-model可以绑定已经上传的图片列表，并展示图片列表的预览图

<van-uploader v-model="fileList" multiple />

export default {
  data() {
    return {
      fileList: [
        { url: 'https://img.yzcdn.cn/vant/leaf.jpg' },
        // Uploader 根据文件后缀来判断是否为图片文件
        // 如果图片 URL 中不包含类型信息，可以添加 isImage 标记来声明
        { url: 'https://cloud-image', isImage: true }
      ]
    }
  }
};

限制上传数量

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

<van-uploader
  v-model="fileList"
  multiple
  :max-count="2"
/>

export default {
  data() {
    return {
      fileList: []
    }
  }
};

自定义上传样式

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

<van-uploader>
  <van-button icon="photo" type="primary">上传图片</van-button>
</van-uploader>

上传前校验

通过传入beforeRead函数可以在上传前进行校验，返回true表示校验通过，返回false表示校验失败。支持返回Promise进行异步校验

<van-uploader :before-read="beforeRead" />

import { Toast } from 'vant';

export default {
  methods: {
    // 返回布尔值
    beforeRead(file) {
      if (file.type !== 'image/jpeg') {
        Toast('请上传 jpg 格式图片');
        return false;
      }
      return true;
    },
    // 返回 Promise
    asyncBeforeRead(file) {
      return new Promise((resolve, reject) => {
        if (file.type !== 'image/jpeg') {
          Toast('请上传 jpg 格式图片');
          reject();
        } else {
          resolve();
        }
      });
    }
  }
}

API

Props

Events

Slots

回调参数

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

ResultType 可选值

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

方法

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