• Notification 通知提醒框

    全局展示通知提醒信息。

    何时使用

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

    代码演示

    最简单的用法,4.5 秒后自动关闭。
    expand code expand code
    import { Button, notification } from 'choerodon-ui';
    
    const openNotification = () => {
      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.',
      });
    };
    
    ReactDOM.render(
      <Button type="primary" onClick={openNotification}>Open the notification box</Button>,
      mountNode);
    
    通知提醒框左侧有图标。
    expand code expand code
    import { Button, notification } from 'choerodon-ui';
    
    const openNotificationWithIcon = (type) => {
      notification[type]({
        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.',
      });
    };
    
    ReactDOM.render(
      <div>
        <Button onClick={() => openNotificationWithIcon('success')}>Success</Button>
        <Button onClick={() => openNotificationWithIcon('info')}>Info</Button>
        <Button onClick={() => openNotificationWithIcon('warning')}>Warning</Button>
        <Button onClick={() => openNotificationWithIcon('error')}>Error</Button>
      </div>,
      mountNode);
    
    图标可以被自定义。
    expand code expand code
    import { Button, notification, Icon } from 'choerodon-ui';
    
    const openNotification = () => {
      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: <Icon type="smile-circle" style={{ color: '#108ee9' }} />,
      });
    };
    
    ReactDOM.render(
      <Button type="primary" onClick={openNotification}>Open the notification box</Button>,
      mountNode);
    
    使用 style 和 className 来定义样式。
    expand code expand code
    import { Button, notification } from 'choerodon-ui';
    
    const openNotification = () => {
      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.',
        style: {
          width: 600,
          marginLeft: 335 - 600,
        },
      });
    };
    
    ReactDOM.render(
      <Button type="primary" onClick={openNotification}>Open the notification box</Button>,
      mountNode);
    
    自定义通知框自动关闭的延时,默认4.5s,取消自动关闭只要将该值设为 0 即可。
    expand code expand code
    import { Button, notification } from 'choerodon-ui';
    
    const openNotification = () => {
      const args = {
        message: 'Notification Title',
        description: 'I will never close automatically. I will be close automatically. I will never close automatically.',
        duration: 0,
      };
      notification.open(args);
    };
    
    ReactDOM.render(
      <Button type="primary" onClick={openNotification}>Open the notification box</Button>,
      mountNode);
    
    自定义关闭按钮的样式和文字。
    expand code expand code
    import { Button, notification } from 'choerodon-ui';
    
    const close = () => {
      console.log('Notification was closed. Either the close button was clicked or duration time elapsed.');
    };
    
    const openNotification = () => {
      const key = `open${Date.now()}`;
      const btn = (
        <Button type="primary" size="small" onClick={() => notification.close(key)}>
          Confirm
        </Button>
      );
      notification.open({
        message: 'Notification Title',
        description: 'A function will be be called after the notification is closed (automatically after the "duration" time of manually).',
        btn,
        key,
        onClose: close,
      });
    };
    
    ReactDOM.render(
      <Button type="primary" onClick={openNotification}>
        Open the notification box
      </Button>,
      mountNode);
    
    可以设置通知从右上角、右下角、左下角、左上角弹出。
    expand code expand code
    import { Button, Select, notification } from 'choerodon-ui';
    
    const { Option } = Select;
    const options = ['topLeft', 'topRight', 'bottomLeft', 'bottomRight'];
    const openNotification = () => {
      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.',
      });
    };
    
    ReactDOM.render(
      <div>
        <Select
          defaultValue="topRight"
          style={{ width: 120, marginRight: 10 }}
          onChange={(val) => {
            notification.config({
              placement: val,
            });
          }}
        >
          {options.map(val => <Option key={val} value={val}>{val}</Option>)}
        </Select>
        <Button
          type="primary"
          onClick={openNotification}
        >
          Open the notification box
        </Button>
      </div>,
      mountNode);
    

    API

    config 参数如下:

    参数说明类型默认值
    btn自定义关闭按钮ReactNode-
    className自定义 CSS classstring-
    description通知提醒内容,必选string|ReactNode-
    duration默认 4.5 秒后自动关闭,配置为 null 则不自动关闭number4.5
    icon自定义图标ReactNode-
    key当前通知唯一标志string-
    message通知提醒标题,必选string|ReactNode-
    placement弹出位置,可选 topLeft topRight bottomLeft bottomRightstringtopRight
    style自定义内联样式React.CSSProperties-
    onClose点击默认关闭按钮时触发的回调函数Function-

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

    notification.config({
      placement: 'bottomRight',
      bottom: 50,
      duration: 3,
    });
    
    参数说明类型默认值
    bottom消息从底部弹出时,距离底部的位置,单位像素。number24
    duration默认自动关闭延时,单位秒number4.5
    getContainer配置渲染节点的输出位置() => HTMLNode() => document.body
    placement弹出位置,可选 topLeft topRight bottomLeft bottomRightstringtopRight
    top消息从顶部弹出时,距离顶部的位置,单位像素。number24