跳转到内容

全局提示 Message

全局提示的基本用法。

设置 closable 来显示关闭按钮。

设置 icon 来自定义图标。

全局提示有 2 种不同的弹出位置,分别为顶部和底部。

全局提示有 6 种不同的类型,分别为:info, success, warning, error, loading。2.41.0 版本增加 normal 类型,此类型下默认没有图标。

更新消息内容,通过设置 duration 属性可以重置定时器。

Message提供的全局方法,可以通过以下三种方法使用:

  1. 通过this.$message调用
  2. 在Composition API中,通过getCurrentInstance().appContext.config.globalProperties.$message调用
  3. 导入Message,通过Message本身调用

当通过 import 方式使用时,组件没有办法获取当前的 Vue Context,如 i18n 或 route 等注入在 AppContext 上的内容无法在内部使用,需要在调用时手动传入 AppContext,或者为组件全局指定 AppContext

import { createApp } from 'vue';
import { Message } from '@sdata/web-vue';
const app = createApp(App);
Message._context = app._context;
参数名描述类型默认值版本
info显示信息提示( config: string | MessageConfig, appContext?: AppContext ) => MessageReturn-
success显示成功提示( config: string | MessageConfig, appContext?: AppContext ) => MessageReturn-
warning显示警告提示( config: string | MessageConfig, appContext?: AppContext ) => MessageReturn-
error显示错误提示( config: string | MessageConfig, appContext?: AppContext ) => MessageReturn-
loading显示加载中提示( config: string | MessageConfig, appContext?: AppContext ) => MessageReturn-
normal显示提示( config: string | MessageConfig, appContext?: AppContext ) => MessageReturn-2.41.0
clear清空全部提示(position?: MessagePosition) => void-
参数名描述类型默认值版本
content内容RenderContent-
id唯一idstring-
icon消息的图标RenderFunction-
position消息的位置'top'|'bottom'-
showIcon是否显示图标booleanfalse
closable是否显示关闭按钮booleanfalse
duration消息显示的持续时间number-
onClose关闭时的回调函数(id: number | string) => void-
resetOnHover设置鼠标移入后不会自动关闭booleanfalse2.39.0
参数名描述类型默认值
close关闭当前消息() => void-