Notification 通知提醒框

全局展示通知提醒信息。

何时使用

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

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

示例

基本用法

<template>
  <f-space>
    <f-button type="primary" @click="openNotification1">常规API</f-button>
    <f-button type="primary" @click="openNotification2">默认图标</f-button>
    <f-button type="primary" @click="openNotification3">自定义图标</f-button>
    <f-button type="primary" @click="openNotification4">自定义按钮</f-button>
    <f-button type="primary" @click="openNotification5">自定义图标+按钮</f-button>
  </f-space>
</template>
<script lang="ts" setup>
import { h } from 'vue'
import { notification, FButton as Button, FSpace as Space } from '@fs/smart-design'
import { CheckCircleFilled, InfoCircleFilled, CloseCircleFilled, ExclamationCircleFilled } from '@ant-design/icons-vue'

const openNotification1 = () => {
  notification.open({
    message: 'Notification Title',
    description:
      'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
    onClick: () => {
      console.log('Notification Clicked!')
    },
  })
}

const types = [
  {
    key: 'success',
    icon: () => h(CheckCircleFilled, { style: 'color: #2FCC83;' }),
  },
  {
    key: 'info',
    icon: () => h(InfoCircleFilled, { style: { color: '#378EEF' } }),
  },
  {
    key: 'warning',
    icon: () => h(ExclamationCircleFilled, { style: { color: '#FA8F23' } }),
  },
  {
    key: 'error',
    icon: () => h(CloseCircleFilled, { style: { color: '#F04141' } }),
  },
]
const randomType = () => types[Math.ceil(Math.random() * 10) % types.length]

const openNotification2 = () => {
  notification[randomType().key]({
    message: 'Notification Title',
    description:
      'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
  })
}

const openNotification3 = () => {
  const cur = randomType()
  notification.open({
    message: 'Notification Title',
    description:
      'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
    icon: () => cur.icon(),
  })
}

const openNotification4 = () => {
  const key = `key:${Date.now()}`
  notification.open({
    message: 'Notification Title',
    description:
      'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
    key,
    btn: () =>
      h(Space, { size: 12 }, [
        h(
          Button,
          {
            onClick: () => notification.close(key),
          },
          { default: () => 'Cancle' }
        ),
        h(
          Button,
          {
            type: 'primary',
            onClick: () => notification.close(key),
          },
          { default: () => 'Confirm' }
        ),
      ]),
  })
}

const openNotification5 = () => {
  const cur = randomType()
  const key = `key:${Date.now()}`
  notification.open({
    message: 'Notification Title',
    description:
      'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
    key,
    icon: () => cur.icon(),

    btn: () =>
      h(Space, { size: 12 }, [
        h(
          Button,
          {
            onClick: () => notification.close(key),
          },
          { default: () => 'Cancle' }
        ),
        h(
          Button,
          {
            type: 'primary',
            onClick: () => notification.close(key),
          },
          { default: () => 'Confirm' }
        ),
      ]),
  })
}
</script>

GlobalAPI用法

<template>
  <f-space>
    <f-button type="primary" @click="openNotificationGlobal">GlobalAPI</f-button>
  </f-space>
</template>
<script lang="ts" setup>
import { getCurrentInstance } from 'vue'

const ins = getCurrentInstance()
const openNotificationGlobal = () => {
  ins?.appContext.config.globalProperties.$notification.open({
    message: 'Notification Title',
    description:
      'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
    onClick: () => {
      console.log('Notification Clicked!')
    },
  })
}
</script>

API

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

config 参数如下：

参数	说明	类型	默认值	版本
bottom	消息从底部弹出时，距离底部的位置，单位像素。	string	24px
btn	自定义关闭按钮	VNode | () => VNode	-
class	自定义 CSS class	string	-
closeIcon	自定义关闭图标	VNode | () => VNode	-
description	通知提醒内容，必选	string | VNode | () => VNode	-
duration	默认 4.5 秒后自动关闭，配置为 null 则不自动关闭	number	4.5
getContainer	配置渲染节点的输出位置	() => HTMLNode	() => document.body
icon	自定义图标	VNode | () => VNode	-
key	当前通知唯一标志	string	-
message	通知提醒标题，必选	string | VNode | () => VNode	-
placement	弹出位置，可选 topLeft topRight bottomLeft bottomRight	string	topRight
style	自定义内联样式	Object | string	-
top	消息从顶部弹出时，距离顶部的位置，单位像素。	string	24px
onClick	点击通知时触发的回调函数	Function	-
onClose	点击默认关闭按钮时触发的回调函数	Function	-

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

• notification.config(options)

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

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

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

参数	说明	类型	默认值	版本
bottom	消息从底部弹出时，距离底部的位置，单位像素。	string	24px
closeIcon	自定义关闭图标	VNode | () => VNode	-
duration	默认自动关闭延时，单位秒	number	4.5
getContainer	配置渲染节点的输出位置	() => HTMLNode	() => document.body
maxCount	最大显示数, 超过限制时，最早的消息会被自动关闭	number	-	3.0
placement	弹出位置，可选 topLeft topRight bottomLeft bottomRight	string	topRight
rtl	是否开启 RTL 模式	boolean	false	3.0
top	消息从顶部弹出时，距离顶部的位置，单位像素。	string	24px