Skip to content

Message 消息

消息组件用于显示全局提示信息,通常从页面顶部滑入显示。支持多种类型、自动关闭、手动关闭等功能。

基础用法

最简单的用法,显示一条信息消息。

不同类型

消息支持多种类型,用于表示不同的语义。

可关闭

可以添加关闭按钮,允许用户手动关闭消息。

自定义持续时间

可以自定义消息的显示时长。

不同位置

可以设置消息显示的位置。

自定义图标

可以自定义消息的图标。

消息堆叠

同一位置的多个消息会自动堆叠显示,最新的消息在上方。

最大消息数量配置

可以配置同时显示的最大消息数量,超出时会自动关闭最旧的消息。

全局方法

Message 提供了一些全局方法来管理消息。

API

Props

名称类型默认值说明
type'default' | 'primary' | 'success' | 'warning' | 'danger' | 'info''info'消息类型
messagestring消息内容
durationnumber3000显示时长,单位毫秒。设为 0 则不会自动关闭
closablebooleantrue是否可关闭
showIconbooleantrue是否显示图标
iconstring | VNode自定义图标
position'top' | 'top-left' | 'top-right''top'消息位置
offsetnumber20距离顶部的偏移量
dangerouslyUseHTMLStringbooleanfalse是否将 message 属性作为 HTML 片段处理
customClassstring自定义类名
customStylestring | object自定义样式
zIndexnumber2000层级

Events

名称参数说明
close关闭时触发
destroy销毁时触发

Methods

方法名说明参数返回值
VkMessage显示消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.success显示成功消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.warning显示警告消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.info显示信息消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.error显示错误消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.danger显示危险消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.primary显示主要消息(message: string)(options: MessageOptions)MessageInstance
VkMessage.close关闭指定消息(id: string)
VkMessage.closeAll关闭所有消息
VkMessage.getInstance获取指定消息实例(id: string)MessageInstance | undefined
VkMessage.getAllInstances获取所有消息实例MessageInstance[]
VkMessage.getCount获取消息数量number
VkMessage.getCountByPosition获取指定位置的消息数量(position: string)number
VkMessage.setMaxCount设置最大消息数量(count: number)
VkMessage.getMaxCount获取最大消息数量number
VkMessage.setMessageGap设置消息间距(gap: number)
VkMessage.getMessageGap获取消息间距number

MessageInstance

属性/方法说明类型
id消息唯一标识string
close关闭消息() => void

基于 MIT 协议发布