Message全局提示

全局展示操作反馈信息。

何时使用#

  • 可提供成功、警告和错误等反馈信息。
  • 顶部居中显示并自动消失,是一种不打断用户操作的轻量级提示方式。
import { NzMessageModule } from 'ng-zorro-antd/message';

代码演示

信息提醒反馈。

expand codeexpand code
加载中

自定义时长 10s,默认时长为 3s

expand codeexpand code
加载中

可通过订阅 onClose 事件在 message 关闭时做出某些操作。以上用例将依次打开三个 message。

expand codeexpand code
加载中

包括成功、失败、警告。

expand codeexpand code
加载中

进行全局 loading,异步自行移除。

expand codeexpand code
加载中

API#

NzMessageService#

组件提供了一些服务方法,使用方式和参数如下:

  • NzMessageService.success(content, [options])
  • NzMessageService.error(content, [options])
  • NzMessageService.info(content, [options])
  • NzMessageService.warning(content, [options])
  • NzMessageService.loading(content, [options])
参数说明类型默认值
content提示内容string | TemplateRef<void>-
options支持设置针对当前提示框的参数,见下方表格object-

options 支持设置的参数如下:

参数说明类型
nzDuration持续时间(毫秒),当设置为0时不消失number
nzPauseOnHover鼠标移上时禁止自动移除boolean
nzAnimate开关动画效果boolean

还提供了全局销毁方法:

  • NzMessageService.remove(id) // 移除特定id的消息,当id为空时,移除所有消息(该消息id通过上述方法返回值中得到)

全局配置#

可以通过 NzConfigService 进行全局配置,详情请见文档中 全局配置项 章节。

参数说明类型默认值
nzDuration持续时间(毫秒),当设置为 0 时不消失number3000
nzMaxStack同一时间可展示的最大提示数量number7
nzPauseOnHover鼠标移上时禁止自动移除booleantrue
nzAnimate开关动画效果booleantrue
nzTop消息距离顶部的位置number | string24
nzDirection消息文字方向'ltr' | 'rtl'-

NzMessageRef#

当你调用 NzMessageService.success 或其他方法时会返回该对象。

export interface NzMessageRef {
  messageId: string;
  onClose: Subject<false>; // 当 message 关闭时它会派发一个事件
}