Vant3 Toast 輕提示

介紹

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

實(shí)例演示

引入

通過以下方式來全局注冊(cè)組件，更多注冊(cè)方式請(qǐng)參考組件注冊(cè)。

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

const app = createApp();
app.use(Toast);

代碼演示

文字提示

Toast('提示內(nèi)容');

加載提示

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

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

成功/失敗提示

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

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

自定義圖標(biāo)

通過 icon 選項(xiàng)可以自定義圖標(biāo)，支持傳入圖標(biāo)名稱或圖片鏈接，通過loadingType 屬性可以自定義加載圖標(biāo)類型。

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

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

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

自定義位置

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

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

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

動(dòng)態(tài)更新提示

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

const toast = Toast.loading({
  duration: 0,
  forbidClick: true,
  message: '倒計(jì)時(shí) 3 秒',
});

let second = 3;
const timer = setInterval(() => {
  second--;
  if (second) {
    toast.message = `倒計(jì)時(shí) ${second} 秒`;
  } else {
    clearInterval(timer);
    Toast.clear();
  }
}, 1000);

全局方法

通過 app.use 全局注冊(cè) Toast 組件后，會(huì)自動(dòng)在 app 的所有子組件上掛載 $toast 方法，便于在組件內(nèi)調(diào)用。

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

Tips: 由于 setup 選項(xiàng)中無法訪問 this，因此不能使用上述方式，請(qǐng)通過 import 引入。

單例模式

Toast 默認(rèn)采用單例模式，即同一時(shí)間只會(huì)存在一個(gè) Toast，如果需要在同一時(shí)間彈出多個(gè) Toast，可以參考下面的示例：

Toast.allowMultiple();

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

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

修改默認(rèn)配置

通過 Toast.setDefaultOptions 函數(shù)可以全局修改 Toast 的默認(rèn)配置。

Toast.setDefaultOptions({ duration: 2000 });

Toast.setDefaultOptions('loading', { forbidClick: true });

Toast.resetDefaultOptions();

Toast.resetDefaultOptions('loading');

API

方法

Options

主題定制

樣式變量

組件提供了下列 CSS 變量，可用于自定義樣式，使用方法請(qǐng)參考 ConfigProvider 組件。