其他提示类型

自定义模板

Message全局提示

全局展示操作反馈信息。

使用

源码

components/message

文档

何时使用#

可提供成功、警告和错误等反馈信息。
顶部居中显示并自动消失，是一种不打断用户操作的轻量级提示方式。

代码演示

信息提醒反馈。

      加载中

自定义时长 10s，默认时长为 3s。

      加载中

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

      加载中

其他提示类型

包括成功、失败、警告。

      加载中

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

      加载中

自定义模板

您可以为消息内容创建自定义模板。通过 nzData 选项，您可以传递一些可选的数据给此自定义模板。

      加载中

API#

NzMessageServiceservice#

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

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`
nzData	传递给自定义模板的数据	`NzSafeAny`

还提供了全局销毁方法：

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

全局配置#

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

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

NzMessageRef#

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

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