Skip to content

Toast 轻提示

继承van-toast所有属性

基本用法

使用 showToast 方法在屏幕中间展示一条文字提示。

成功/失败提示

使用 showSuccessToast 方法展示成功提示,使用 showFailToast 方法展示失败提示。

自定义位置

Toast 默认渲染在屏幕正中位置,通过 position 属性可以控制 Toast 展示的位置。

使用 Toast 组件

如果你需要在 Toast 内嵌入组件或其他自定义内容,可以直接使用 Toast 组件,并使用 message 插槽进行定制。使用前需要通过 app.use 等方式注册组件。

API

方法名说明参数返回值
showToast展示一条文字提示message: stringvoid
showLoadingToast展示一个加载中提示message: stringvoid
showSuccessToast展示一条成功提示message: stringvoid
showFailToast展示一条失败提示message: stringvoid
closeToast关闭当前正在展示的提示void
allowMultipleToast是否允许同时展示多个提示allow: booleanvoid
setToastDefaultOptions设置 Toast 默认参数options: ToastOptionsvoid
resetToastDefaultOptions重置 Toast 默认参数void

ToastOptions 数据结构

调用 showToast 等方法时,支持传入以下选项: 通过组件调用 Toast 时,支持以下 Props:

参数说明类型默认值
type提示类型,可选值为 loading success fail htmlToastTypetext
position位置,可选值为 top bottomToastPositionmiddle
message文本内容,支持通过\n换行string''
overlay是否显示背景遮罩层booleanfalse
className自定义类名string 、 Array 、 object-
overlayClass自定义遮罩层类名string、Array 、 object-
overlayStyle自定义遮罩层样式object-
duration展示时长(ms),值为 0 时,toast 不会消失number2000
z-index将组件的 z-index 层级设置为一个固定值number、string2000+
onClose关闭时的回调函数Function-
onOpened完全展示后的回调函数Function-