1.0.5 • Published 5 years ago

@icedesign/notification v1.0.5

Weekly downloads
26
License
-
Repository
github
Last release
5 years ago

title: Notification category: Components

chinese: 通知提醒框

全局展示通知提醒信息。

组件实现参照 antd 的 Notification 组件,并针对 ICE 做了适配

安装和升级

def add @icedesign/notification

API

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

config 参数如下:

参数说明类型默认值
message通知提醒标题,必选string|ReactNode-
description通知提醒内容,必选string|ReactNode-
btn自定义关闭按钮ReactNode-
icon自定义图标ReactNode-
key当前通知唯一标志string-
onClose点击默认关闭按钮时触发的回调函数Function-
duration默认 4.5 秒后自动关闭,配置为 null 则不自动关闭number4.5
placement弹出位置,可选 topLeft topRight bottomLeft``bottomRight | string | topRight
getContainer配置渲染节点的输出位置() => HTMLNode() => document.body

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

  • notification.config(options)
IceNotification.config({
  placement: 'bottomRight',
  bottom: 50,
  duration: 3,
});
参数说明类型默认值
placement弹出位置,可选 topLeft topRight bottomLeft``bottomRight | string | topRight
top消息从顶部弹出时,距离顶部的位置,单位像素。number24
bottom消息从底部弹出时,距离底部的位置,单位像素。number24
duration默认自动关闭延时,单位秒number4.5

感谢 Antd 团队