Toast 轻提示

引入

app.jsonindex.json中引入组件,详细介绍见快速上手

  1. "usingComponents": {
  2. "van-toast": "@vant/weapp/toast/index"
  3. }

代码演示

文字提示

  1. import Toast from 'path/to/@vant/weapp/dist/toast/toast';
  2. Toast('我是提示文案,建议不超过十五字~');
  1. <van-toast id="van-toast" />

加载提示

使用 Toast.loading 方法展示加载提示,通过 forbidClick 属性可以禁用背景点击,通过 loadingType 属性可以自定义加载图标类型。

  1. Toast.loading({
  2. message: '加载中...',
  3. forbidClick: true,
  4. });
  5. // 自定义加载图标
  6. Toast.loading({
  7. message: '加载中...',
  8. forbidClick: true,
  9. loadingType: 'spinner',
  10. });

成功/失败提示

  1. Toast.success('成功文案');
  2. Toast.fail('失败文案');

动态更新提示

  1. const toast = Toast.loading({
  2. duration: 0, // 持续展示 toast
  3. forbidClick: true,
  4. message: '倒计时 3 秒',
  5. selector: '#custom-selector',
  6. });
  7. let second = 3;
  8. const timer = setInterval(() => {
  9. second--;
  10. if (second) {
  11. toast.setData({
  12. message: `倒计时 ${second} 秒`,
  13. });
  14. } else {
  15. clearInterval(timer);
  16. Toast.clear();
  17. }
  18. }, 1000);
  1. <van-toast id="custom-selector" />

OnClose 回调函数

  1. Toast({
  2. type: 'success',
  3. message: '提交成功',
  4. onClose: () => {
  5. console.log('执行OnClose函数');
  6. },
  7. });

API

方法

方法名参数返回值介绍
Toastoptions | messagetoast 实例展示提示
Toast.loadingoptions | messagetoast 实例展示加载提示
Toast.successoptions | messagetoast 实例展示成功提示
Toast.failoptions | messagetoast 实例展示失败提示
Toast.clearclearAllvoid关闭提示
Toast.setDefaultOptionsoptionsvoid修改默认配置,对所有 Toast 生效
Toast.resetDefaultOptions-void重置默认配置,对所有 Toast 生效

Options

参数说明类型默认值版本
type提示类型,可选值为 loading success fail htmlstringtext-
position位置,可选值为 top middle bottomstringmiddle-
message内容string‘’-
mask是否显示遮罩层booleanfalse-
forbidClick是否禁止背景点击booleanfalse-
loadingType加载图标类型, 可选值为 spinnerstringcircular-
zIndexz-index 层级number1000-
duration展示时长(ms),值为 0 时,toast 不会消失number2000-
selector自定义选择器stringvan-toast-
context选择器的选择范围,可以传入自定义组件的 this 作为上下文object当前页面-
onClose关闭时的回调函数Function--

Slot

名称说明
-自定义内容

Toast 轻提示 - 图1