vant/packages/uploader/en-US.md

Uploader

Install

import { Uploader } from 'vant';

Vue.use(Uploader);

Usage

Basic Usage

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

export default {
  methods: {
    afterRead(file) {
      console.log(file)
    }
  }
};

Preview File

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

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

Max Count

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

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

Upload Style

<van-uploader>
  <van-button icon="photo" type="primary">Upload Image</van-button>
</van-uploader>

Before Read

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

export default {
  methods: {
    beforeRead(file) {
      if (file.type !== 'image/jpeg') {
        Toast('Please upload an image in jpg format');
        return false;
      }
    
      return true;
    },

    asyncBeforeRead(file) {
      return new Promise((resolve, reject) => {
        if (file.type !== 'image/jpeg') {
          Toast('Please upload an image in jpg format');
          reject();
        } else {
          resolve();
        }
      });
    }
  }
}

API

Props

Attribute	Description	Type	Default
name	Input name	String	-
accept	Accepted file type	String	image/*
preview-image	Whether to show image preview	Boolean	true
preview-size	Size of preview image	`String	Number`
multiple	Whether to enable multiple selection pictures	Boolean	false
disabled	Whether to disabled the upload	Boolean	false
capture	Capture，can be set to camera	String	-
before-read	Hook before reading the file, return false to stop reading the file, can return Promise	Function	-
after-read	Hook after reading the file	Function	-
max-size	Max size of file	Number	-
max-count	Max count of image	Number	-
result-type	Type of file read result, can be set to dataUrl text	String	dataUrl
upload-text	Upload text	String	-

Events

Event	Description	Arguments
oversize	Triggered when file size over limit	Same as after-read
delete	Triggered when delete preview file	file

Slots

Name	Description
default	Custom icon

Parematers of before-read、after-read

Attribute	Description	Type
file	File object	Object
detail	Detail info	Object