Toast 轻提示
基本用法
使用 showToast 方法在屏幕中间展示一条文字提示。
成功/失败提示
使用 showSuccessToast 方法展示成功提示,使用 showFailToast 方法展示失败提示。
自定义位置
Toast 默认渲染在屏幕正中位置,通过 position 属性可以控制 Toast 展示的位置。
使用 Toast 组件
如果你需要在 Toast 内嵌入组件或其他自定义内容,可以直接使用 Toast 组件,并使用 message 插槽进行定制。使用前需要通过 app.use 等方式注册组件。
API
| 方法名 | 说明 | 参数 | 返回值 |
|---|---|---|---|
| showToast | 展示一条文字提示 | message: string | void |
| showLoadingToast | 展示一个加载中提示 | message: string | void |
| showSuccessToast | 展示一条成功提示 | message: string | void |
| showFailToast | 展示一条失败提示 | message: string | void |
| closeToast | 关闭当前正在展示的提示 | 无 | void |
| allowMultipleToast | 是否允许同时展示多个提示 | allow: boolean | void |
| setToastDefaultOptions | 设置 Toast 默认参数 | options: ToastOptions | void |
| resetToastDefaultOptions | 重置 Toast 默认参数 | 无 | void |
ToastOptions 数据结构
调用 showToast 等方法时,支持传入以下选项: 通过组件调用 Toast 时,支持以下 Props:
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| type | 提示类型,可选值为 loading success fail html | ToastType | text |
| position | 位置,可选值为 top bottom | ToastPosition | middle |
| message | 文本内容,支持通过\n换行 | string | '' |
| overlay | 是否显示背景遮罩层 | boolean | false |
| className | 自定义类名 | string 、 Array 、 object | - |
| overlayClass | 自定义遮罩层类名 | string、Array 、 object | - |
| overlayStyle | 自定义遮罩层样式 | object | - |
| duration | 展示时长(ms),值为 0 时,toast 不会消失 | number | 2000 |
| z-index | 将组件的 z-index 层级设置为一个固定值 | number、string | 2000+ |
| onClose | 关闭时的回调函数 | Function | - |
| onOpened | 完全展示后的回调函数 | Function | - |