Notification

何时使用 {#when-to-use}

在系统四个角显示通知提醒信息。经常用于以下情况：

• 较为复杂的通知内容。
• 带有交互的通知，给出用户下一步的行动点。
• 系统主动推送。

代码演示 {#examples}

<code src="./demo/hooks.tsx">Hooks 调用（推荐）</code> <code src="./demo/duration.tsx">自动关闭的延时</code> <code src="./demo/with-icon.tsx">带有图标的通知提醒框</code> <code src="./demo/with-btn.tsx">自定义按钮</code> <code src="./demo/custom-icon.tsx">自定义图标</code> <code src="./demo/placement.tsx">位置</code> <code src="./demo/custom-style.tsx">自定义样式</code> <code src="./demo/update.tsx">更新消息内容</code> <code src="./demo/stack.tsx" version="5.10.0">堆叠</code> <code src="./demo/show-with-progress.tsx" version="5.18.0">显示进度条</code> <code src="./demo/basic.tsx">静态方法（不推荐）</code> <code src="./demo/progress-color.tsx">自定义进度条颜色</code> <code src="./demo/component-token.tsx" debug>组件 Token</code> <code src="./demo/render-panel.tsx" debug>_InternalPanelDoNotUseOrYouWillBeFired</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code>

API

通用属性参考：通用属性

• notification.success(config)
• notification.error(config)
• notification.info(config)
• notification.warning(config)
• notification.open(config)
• notification.destroy(key?: String)

config 参数如下：

• notification.useNotification(config)

config 参数如下：

ClosableType

全局配置

还提供了一个全局配置方法，在调用前提前配置，全局一次生效。

notification.config(options)

当你使用 ConfigProvider 进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)

当你想单独使用，可��过如下设置开启 RTL 模式。

notification.config({
  placement: 'bottomRight',
  bottom: 50,
  duration: 3,
  rtl: true,
});

notification.config

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

主题变量（Design Token）{#design-token}

<ComponentTokenTable component="Notification"></ComponentTokenTable>

FAQ

为什么 notification 不能获取 context、redux 的内容和 ConfigProvider 的 locale/prefixCls/theme 等配置？ {#faq-context-redux}

直接调用 notification 方法，antd 会通过 ReactDOM.render 动态创建新的 React 实体。其 context 与当前代码所在 context 并不相同，因而无法获取 context 信息。

当你需要 context 信息（例如 ConfigProvider 配置的内容）时，可以通过 notification.useNotification 方法会返回 api 实体以及 contextHolder 节点。将其插入到你需要获取 context 位置即可：

const [api, contextHolder] = notification.useNotification();

return (
  <Context1.Provider value="Ant">
    {contextHolder}
    <Context2.Provider value="Design">
    </Context2.Provider>
  </Context1.Provider>
);

异同：通过 hooks 创建的 contextHolder 必须插入到子元素节点中才会生效，当你不需要上下文信息时请直接调用。

可通过 App 包裹组件 简化 useNotification 等方法需要手动植入 contextHolder 的问题。

静态方法如何设置 prefixCls ？ {#faq-set-prefix-cls}

你可以通过 ConfigProvider.config 进行设置。