Toast 轻提示

使用指南

在 app.json 或 index.json 中引入组件

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

代码演示

文字提示

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

加载提示

  1. Toast.loading({
  2. mask: true,
  3. message: '加载中...'
  4. });

成功/失败提示

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

高级用法

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

方法

方法名参数返回值介绍
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 不会消失Number3000
selector自定义选择器Stringvan-toast
context选择器的选择范围,可以传入自定义组件的 this 作为上下文Object当前页面

更新日志

版本类型内容
0.1.1feature新增组件
0.3.0breaking change修改组件引入路径,避免编辑器报错的问题
0.3.2feature新增 z-index 属性
0.3.3bugfix修复滚动穿透问题

原文: https://youzan.github.io/vant-weapp/#/toast