Skip to content

Toast 通知

通知组件,用于操作反馈提示。

何时使用:操作完成后需要短暂反馈(成功、失败、警告)时使用,自动消失。

函数式调用(推荐)

Nuxt 环境使用

在 Nuxt 中使用 Toast,需要确保只在客户端执行。详见 Nuxt 集成指南

组件式调用

自定义图标

API

Props

属性类型默认值说明
modelValuebooleanfalse是否显示(v-model)
messagestring''消息内容
type'success' | 'error' | 'warning' | 'info''info'通知类型
durationnumber3000持续时间(毫秒),0 表示不自动关闭
closablebooleanfalse是否显示关闭按钮
position'top' | 'bottom''top'显示位置
iconstring''自定义图标(不传则按类型显示默认图标 ✓ ✗ ⚠ ℹ)
closeAriaLabelstring''关闭按钮的 aria-label

Slots

名称说明
default消息内容(优先级高于 message prop)
icon自定义图标

Events

事件参数说明
update:modelValue(value: boolean)显示状态变化时触发
close关闭时触发

useToast API

方法

方法参数说明
show(options: ToastOptions)显示通知
success(message: string, options?)成功通知
error(message: string, options?)错误通知
warning(message: string, options?)警告通知
info(message: string, options?)信息通知

ToastOptions

属性类型默认值说明
messagestring消息内容
type'success' | 'error' | 'warning' | 'info''info'通知类型
durationnumber3000持续时间
closablebooleanfalse是否可关闭
position'top' | 'bottom''top'显示位置
iconstring''自定义图标

注意事项

  • 推荐使用 useToast 函数式调用,代码更简洁
  • Nuxt 环境中:请参考 Nuxt 集成指南
  • 同时显示多个通知时会堆叠显示(后出现的在下方)
  • 通知会自动消失,也可手动关闭(需启用 closable
  • 未传 icon 时,每种类型会自动显示默认图标:success → ✓、error → ✗、warning → ⚠、info → ℹ
  • 支持顶部和底部两种位置
  • 移动端自动适配铺满宽度

Released under the MIT License