引入

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

Vue.use(Uploader);

基礎用法

文件上傳完畢后會觸發(fā) 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://img01.yzcdn.cn/vant/leaf.jpg' },
        // Uploader 根據文件后綴來判斷是否為圖片文件
        // 如果圖片 URL 中不包含類型信息，可以添加 isImage 標記來聲明
        { url: 'https://cloud-image', isImage: true },
      ],
    };
  },
};

上傳狀態(tài)

通過 status 屬性可以標識上傳狀態(tài)，uploading 表示上傳中，failed 表示上傳失敗，done 表示上傳完成。

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

export default {
  data() {
    return {
      fileList: [
        {
          url: 'https://img01.yzcdn.cn/vant/leaf.jpg',
          status: 'uploading',
          message: '上傳中...',
        },
        {
          url: 'https://img01.yzcdn.cn/vant/tree.jpg',
          status: 'failed',
          message: '上傳失敗',
        },
      ],
    };
  },
  methods: {
    afterRead(file) {
      file.status = 'uploading';
      file.message = '上傳中...';

      setTimeout(() => {
        file.status = 'failed';
        file.message = '上傳失敗';
      }, 1000);
    },
  },
};

限制上傳數量

通過 max-count 屬性可以限制上傳文件的數量，上傳數量達到限制后，會自動隱藏上傳區(qū)域。

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

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

限制上傳大小

通過 max-size 屬性可以限制上傳文件的大小，超過大小的文件會被自動過濾，這些文件信息可以通過 oversize 事件獲取。

<van-uploader multiple :max-size="500 * 1024" @oversize="onOversize" />

import { Toast } from 'vant';

export default {
  methods: {
    onOversize(file) {
      console.log(file);
      Toast('文件大小不能超過 500kb');
    },
  },
};

如果需要針對不同類型的文件來作出不同的大小限制，可以在 max-size 屬性中傳入一個函數，在函數中通過 file.type 區(qū)分文件類型，返回 true 表示超出限制，false 表示未超出限制。

<van-uploader multiple :max-size="isOverSize" />

import { Toast } from 'vant';

export default {
  methods: {
    isOverSize(file) {
      const maxSize = file.type === 'image/jpeg' ? 500 * 1024 : 1000 * 1024;
      return file.size >= maxSize;
    },
  },
};

自定義上傳樣式

通過默認插槽可以自定義上傳區(qū)域的樣式。

<van-uploader>
  <van-button icon="plus" type="primary">上傳文件</van-button>
</van-uploader>

自定義預覽樣式

通過 preview-cover 插槽可以自定義覆蓋在預覽區(qū)域上方的內容。

<van-uploader v-model="fileList">
  <template #preview-cover="{ file }">
    <div class="preview-cover van-ellipsis">{{ file.name }}</div>
  </template>
</van-uploader>

<style>
  .preview-cover {
    position: absolute;
    bottom: 0;
    box-sizing: border-box;
    width: 100%;
    padding: 4px;
    color: #fff;
    font-size: 12px;
    text-align: center;
    background: rgba(0, 0, 0, 0.3);
  }
</style>

上傳前置處理

通過傳入 beforeRead 函數可以在上傳前進行校驗和處理，返回 true 表示校驗通過，返回 false 表示校驗失敗。支持返回 Promise 對 file 對象進行自定義處理，例如壓縮圖片。

<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 {
          let img = new File(['foo'], 'bar.jpg', {
            type: 'image/jpeg',
          });
          resolve(img);
        }
      });
    },
  },
};

禁用文件上傳

通過 disabled 屬性禁用文件上傳。

<van-uploader disabled />

自定義單個圖片預覽

在 v-model 數組中設置單個預覽圖片屬性，支持 imageFit deletable previewSize beforeDelete，從 2.12 版本開始支持。

<van-uploader v-model="fileList" :deletable="false" />

import { Toast } from 'vant';

export default {
  data() {
    return {
      fileList = [
        { url: 'https://img01.yzcdn.cn/vant/leaf.jpg' },
        {
          url: 'https://img01.yzcdn.cn/vant/sand.jpg',
          deletable: true,
          beforeDelete: () => {
            Toast('自定義單個預覽圖片的事件和樣式');
          },
        },
        {
          url: 'https://img01.yzcdn.cn/vant/tree.jpg',
          deletable: true,
          imageFit: 'contain',
          previewSize: 120,
        },
      ];
    }
  }
};

Props

注意：accept、capture 和 multiple 為瀏覽器 input 標簽的原生屬性，移動端各種機型對這些屬性的支持程度有所差異，因此在不同機型和 WebView 下可能出現一些兼容性問題。

Events

Slots

回調參數

before-read、after-read、before-delete 執(zhí)行時會傳遞以下回調參數：

ResultType  可選值

result-type 字段表示文件讀取結果的類型，上傳大文件時，建議使用 file 類型，避免卡頓。

方法

通過 ref 可以獲取到 Uploader 實例并調用實例方法，詳見組件實例方法。

樣式變量

組件提供了下列 Less 變量，可用于自定義樣式，使用方法請參考主題定制。

Uploader 在部分安卓機型上無法上傳圖片？

Uploader 采用了 HTML 原生的 <input type="file /> 標簽進行上傳，能否上傳取決于當前系統和瀏覽器的兼容性。當遇到無法上傳的問題時，一般有以下幾種情況：

1. 遇到了安卓 App WebView 的兼容性問題，需要在安卓原生代碼中進行兼容，可以參考此文章。
2. 圖片格式不正確，在當前系統/瀏覽器中無法識別，比如 webp 或 heic 格式。
3. 其他瀏覽器兼容性問題。

拍照上傳的圖片被旋轉 90 度？

部分手機在拍照上傳時會出現圖片被旋轉 90 度的問題，這個問題可以通過 compressorjs 或其他開源庫進行處理。

compressorjs 是一個開源的圖片處理庫，提供了圖片壓縮、圖片旋轉等能力。

示例

使用 compressorjs 進行處理的示例代碼如下:

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

import Compressor from 'compressorjs';

export default {
  methods: {
    beforeRead(file) {
      return new Promise((resolve) => {
        // compressorjs 默認開啟 checkOrientation 選項
        // 會將圖片修正為正確方向
        new Compressor(file, {
          success: resolve,
          error(err) {
            console.log(err.message);
          },
        });
      });
    },
  },
};

上傳圖片時出現瀏覽器刷新或卡頓現象？

這種現象一般是內存不足導致的，通常發(fā)生在舊機型上；上傳一張較大的圖片引起也引起此現象。

為了減少這種情況的出現，可以在上傳圖片前對圖片進行壓縮，壓縮方法請參考上文中的提到的 compressorjs 庫。

上傳 HEIC/HEIF 格式的圖片后無法展示？

目前 Chrome、Safari 等瀏覽器不支持展示 HEIC/HEIF 格式的圖片，因此上傳后無法在 Uploader 組件中進行預覽。

[HEIF] 格式的兼容性請參考 caniuse。