102 lines
2.5 KiB
Markdown
102 lines
2.5 KiB
Markdown
## Toast 轻提示
|
|
|
|
### 使用指南
|
|
|
|
```javascript
|
|
import { Toast } from 'vant';
|
|
```
|
|
|
|
### 代码演示
|
|
|
|
#### 文字提示
|
|
|
|
```javascript
|
|
Toast('我是提示文案，建议不超过十五字~');
|
|
```
|
|
|
|
|
|
#### 加载提示
|
|
|
|
```javascript
|
|
Toast.loading({ mask: true });
|
|
```
|
|
|
|
|
|
#### 成功/失败提示
|
|
|
|
```javascript
|
|
Toast.success('成功文案');
|
|
Toast.fail('失败文案');
|
|
```
|
|
|
|
|
|
#### 高级用法
|
|
|
|
```javascript
|
|
const toast = Toast.loading({
|
|
duration: 0, // 持续展示 toast
|
|
forbidClick: true, // 禁用背景点击
|
|
message: '倒计时 3 秒'
|
|
});
|
|
|
|
let second = 3;
|
|
const timer = setInterval(() => {
|
|
second--;
|
|
if (second) {
|
|
toast.message = `倒计时 ${second} 秒`;
|
|
} else {
|
|
clearInterval(timer);
|
|
Toast.clear();
|
|
}
|
|
}, 1000);
|
|
```
|
|
|
|
#### 组件内调用
|
|
引入 Toast 组件后，会自动在 Vue 的 prototype 上挂载 $toast 方法，便于在组件内调用。
|
|
|
|
```js
|
|
export default {
|
|
mounted() {
|
|
this.$toast('提示文案');
|
|
}
|
|
}
|
|
```
|
|
|
|
#### 单例模式
|
|
Toast 默认采用单例模式，即同一时间只会存在一个 Toast，如果需要在同一时间弹出多个 Toast，可以参考下面的示例
|
|
|
|
```js
|
|
Toast.allowMultiple();
|
|
|
|
const toast1 = Toast('第一个 Toast');
|
|
const toast2 = Toast.success('第二个 Toast');
|
|
|
|
toast1.clear();
|
|
toast2.clear();
|
|
```
|
|
|
|
|
|
### 方法
|
|
|
|
| 方法名 | 参数 | 返回值 | 介绍 |
|
|
|-----------|-----------|-----------|-------------|
|
|
| Toast | `options | message` | toast 实例 | 展示提示 |
|
|
| Toast.loading | `options | message` | toast 实例 | 展示加载提示 |
|
|
| Toast.success | `options | message` | toast 实例 | 展示成功提示 |
|
|
| Toast.fail | `options | message` | toast 实例 | 展示失败提示 |
|
|
| Toast.clear | `clearAll` | `void` | 关闭提示 |
|
|
| Toast.allowMultiple | - | `void` | 允许同时存在多个 Toast |
|
|
| Toast.setDefaultOptions | `options` | `void` | 修改默认配置，对所有 Toast 生效 |
|
|
| Toast.resetDefaultOptions | - | `void` | 重置默认配置，对所有 Toast 生效 |
|
|
|
|
### Options
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|
|
|-----------|-----------|-----------|-------------|-------------|
|
|
| type | 提示类型 | `String` | `text` | `loading` `success` `fail` `html` |
|
|
| message | 内容 | `String` | `''` | - |
|
|
| position | 位置 | `String` | `middle` | `top` `bottom` |
|
|
| mask | 是否显示背景蒙层 | `Boolean` | `false` | - |
|
|
| forbidClick | 禁止背景点击 | `Boolean` | `false` | - |
|
|
| duration | 时长(ms) | `Number` | `3000` | 值为 0 时，toast 不会消失 |
|