vant/docs/examples-docs/toast.md

Toast 轻提示

使用指南

Toast和其他组件不同，不是通过HTML结构的方式来使用，而是通过函数调用的方式。使用前需要先引入它。

import { Toast } from 'vant';

代码演示

基础用法

:::demo 基础用法

<van-button @click="showSimpleToast">普通文字提示</van-button>
<van-button @click="showLoadingToast">加载Toast</van-button>
<van-button @click="showSuccessToast">成功</van-button>
<van-button @click="showFailToast">失败</van-button>
<van-button @click="showForbidClickToast">背景不能点击</van-button>
<van-button @click="showCustomizedToast(5000)">倒数5秒</van-button>

<script>
import { Toast } from 'packages/index';

export default {
  methods: {
    showSimpleToast() {
      Toast('我是提示文案，建议不超过十五字~');
    },
    showLoadingToast() {
      Toast.loading();
    },
    showSuccessToast() {
      Toast.success('成功文案');
    },
    showFailToast() {
      Toast.fail('失败文案');
    },
    showForbidClickToast() {
      Toast({
        message: '背景不能点击',
        forbidClick: true
      })
    },
    showCustomizedToast(duration) {
      let leftSec = duration / 1000;
      let toast = Toast({
        duration: duration + 1000,
        type: 'success',
        message: leftSec.toString()
      });
      const id = window.setInterval(() => {
        if (leftSec <= 1) {
          window.clearInterval(id);
          toast.message = '跳转中...'
          return;
        }
        toast.message = (--leftSec).toString();
      }, 1000);
    }
  }
};
</script>

:::

手动关闭

:::demo 手动关闭

<van-button @click="showToast">打开</van-button>
<van-button @click="closeToast">关闭</van-button>

<script>
import { Toast } from 'packages/index';

export default {
  methods: {
    showToast() {
      Toast('我是提示文案，建议不超过十五字~');
    },
    closeToast() {
      Toast.clear();
    }
  }
};
</script>

:::

传入html

:::demo 手动关闭

<van-button @click="showHtmlToast">打开</van-button>

<script>
import { Toast } from 'packages/index';

export default {
  methods: {
    showHtmlToast() {
      Toast({
        type: 'html',
        message: '<em>HTML<em>'
      })
    }
  }
};
</script>

:::

基础用法

Toast(options)

参数	说明	类型	默认值	可选值
type	类型	String	'text'	'text', 'loading', 'success', 'fail', 'html'
message	内容	String	''	-
forbidClick	不允许背景点击	Boolean	false	true, false
duration	时长(ms)	Number	3000ms	-

快速用法

Toast(message) || Toast(message, options)

参数	说明	类型	默认值	可选值
message	内容	String	''	-
forbidClick	不允许背景点击	Boolean	false	true, false
duration	时长(ms)	Number	3000ms	-

Toast.loading() || Toast.loading(message, options)

参数	说明	类型	默认值	可选值
forbidClick	不允许背景点击	Boolean	false	true, false
duration	时长(ms)	Number	3000ms	-

Toast.success(message) || Toast.success(message, options)

参数	说明	类型	默认值	可选值
type	类型	String	'text'	'text', 'loading', 'success', 'failure'
forbidClick	不允许背景点击	Boolean	false	true, false
duration	时长(ms)	Number	3000ms	-

Toast.fail(message) || Toast.fail(message, options)

参数	说明	类型	默认值	可选值
type	类型	String	'text'	'text', 'loading', 'success', 'failure'
forbidClick	不允许背景点击	Boolean	false	true, false
duration	时长(ms)	Number	3000ms	-

Toast.clear()

关闭toast。