Toast 轻提示
使用指南
在 app.json 或 index.json 中引入组件
"usingComponents": {
"van-toast": "path/to/vant-weapp/dist/toast/index"
}
代码演示
文字提示
import Toast from 'path/to/vant-weapp/dist/toast/toast';
Toast('我是提示文案,建议不超过十五字~');
<van-toast id="van-toast" />
加载提示
Toast.loading({
mask: true,
message: '加载中...'
});
成功/失败提示
Toast.success('成功文案');
Toast.fail('失败文案');
高级用法
const toast = Toast.loading({
duration: 0,
forbidClick: true,
message: '倒计时 3 秒',
loadingType: 'spinner',
selector: '#custom-selector'
});
let second = 3;
const timer = setInterval(() => {
second--;
if (second) {
toast.setData({
message: `倒计时 ${second} 秒`
});
} else {
clearInterval(timer);
Toast.clear();
}
}, 1000);
<van-toast id="custom-selector" />
方法
方法名 | 参数 | 返回值 | 介绍 |
---|
Toast | options | message | toast 实例 | 展示提示 |
Toast.loading | options | message | toast 实例 | 展示加载提示 |
Toast.success | options | message | toast 实例 | 展示成功提示 |
Toast.fail | options | message | toast 实例 | 展示失败提示 |
Toast.clear | clearAll | void | 关闭提示 |
Toast.setDefaultOptions | options | void | 修改默认配置,对所有 Toast 生效 |
Toast.resetDefaultOptions | - | void | 重置默认配置,对所有 Toast 生效 |
Options
参数 | 说明 | 类型 | 默认值 |
---|
type | 提示类型,可选值为 loading success fail html | String | text |
position | 位置,可选值为 top middle bottom | String | middle |
message | 内容 | String | '' |
mask | 是否显示背景蒙层 | Boolean | false |
forbidClick | 是否禁止背景点击 | Boolean | false |
loadingType | 加载图标类型, 可选值为 spinner | String | circular |
zIndex | z-index 层级 | Number | 1000 |
duration | 展示时长(ms),值为 0 时,toast 不会消失 | Number | 3000 |
selector | 自定义选择器 | String | van-toast |
context | 选择器的选择范围,可以传入自定义组件的 this 作为上下文 | Object | 当前页面 |
更新日志
版本 | 类型 | 内容 |
---|
0.1.1 | feature | 新增组件 |
0.3.0 | breaking change | 修改组件引入路径,避免编辑器报错的问题 |
0.3.2 | feature | 新增 z-index 属性 |
0.3.3 | bugfix | 修复滚动穿透问题 |
原文: https://youzan.github.io/vant-weapp/#/toast