介紹

在頁面中間彈出黑色半透明提示，用于消息通知、加載提示、操作結果提示等場景。

引入

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

Vue.use(Toast);

代碼演示

文字提示

Toast('提示內容');

加載提示

使用 Toast.loading 方法展示加載提示，通過 forbidClick 屬性可以禁用背景點擊。

Toast.loading({
  message: '加載中...',
  forbidClick: true,
});

成功/失敗提示

使用 Toast.success 方法展示成功提示，使用 Toast.fail 方法展示失敗提示。

Toast.success('成功文案');
Toast.fail('失敗文案');

自定義圖標

通過 icon 選項可以自定義圖標，支持傳入圖標名稱或圖片鏈接，通過loadingType 屬性可以自定義加載圖標類型。

Toast({
  message: '自定義圖標',
  icon: 'like-o',
});

Toast({
  message: '自定義圖片',
  icon: 'https://img01.yzcdn.cn/vant/logo.png',
});

// 自定義加載圖標
Toast.loading({
  message: '加載中...',
  forbidClick: true,
  loadingType: 'spinner',
});

自定義位置

Toast 默認渲染在屏幕正中位置，通過 position 屬性可以控制 Toast 展示的位置。

Toast({
  message: '頂部展示',
  position: 'top',
});

Toast({
  message: '底部展示',
  position: 'bottom',
});

動態(tài)更新提示

執(zhí)行 Toast 方法時會返回對應的 Toast 實例，通過修改實例上的 message 屬性可以實現(xiàn)動態(tài)更新提示的效果。

const toast = Toast.loading({
  duration: 0, // 持續(xù)展示 toast
  forbidClick: true,
  message: '倒計時 3 秒',
});

let second = 3;
const timer = setInterval(() => {
  second--;
  if (second) {
    toast.message = `倒計時 ${second} 秒`;
  } else {
    clearInterval(timer);
    // 手動清除 Toast
    Toast.clear();
  }
}, 1000);

全局方法

引入 Toast 組件后，會自動在 Vue 的 prototype 上掛載 $toast 方法，便于在組件內調用。

export default {
  mounted() {
    this.$toast('提示文案');
  },
};

單例模式

Toast 默認采用單例模式，即同一時間只會存在一個 Toast，如果需要在同一時間彈出多個 Toast，可以參考下面的示例：

Toast.allowMultiple();

const toast1 = Toast('第一個 Toast');
const toast2 = Toast.success('第二個 Toast');

toast1.clear();
toast2.clear();

修改默認配置

通過 Toast.setDefaultOptions 函數可以全局修改 Toast 的默認配置。

// 將所有 Toast 的展示時長設置為 2000 毫秒
Toast.setDefaultOptions({ duration: 2000 });

// 將所有 loading Toast 設置為背景不可點擊
Toast.setDefaultOptions('loading', { forbidClick: true });

// 重置所有 Toast 的默認配置
Toast.resetDefaultOptions();

// 重置 loading Toast 的默認配置
Toast.resetDefaultOptions('loading');

API

方法

Options

樣式變量

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