深圳幻海软件技术有限公司 欢迎您！
更多

精通React/Vue系列之手把手带你实现一个功能强大的通知提醒框(Notification)

2023-02-28

组件 通知 icon
前言本文是笔者写组件设计的第十篇文章,今天带大家实现一个比较特殊的组件——通知提醒框(Notification)。该组件在诸如Antd或者elementUI等第三方组件库中也都会出现,主要用来为用户提供系统通知信息的.我们在调用它时并不像其他组件一样，通过引入组件标签来调用。比如Modal组件，我们

前言

本文是笔者写组件设计的第十篇文章, 今天带大家实现一个比较特殊的组件——通知提醒框(Notification)。 该组件在诸如Antd或者elementUI等第三方组件库中也都会出现,主要用来为用户提供系统通知信息的.我们在调用它时并不像其他组件一样，通过引入组件标签来调用。比如Modal组件，我们一般这样来调用：

<Modal title="xui基础弹窗" centered mask={false} visible={false}>
    <p>我是弹窗内容</p>
    <p>我是弹窗内容</p>
    <p>我是弹窗内容</p>
    <p>我是弹窗内容</p>
</Modal>
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

但是通知提醒框(Notification)，大多数场景下是使用js API的方式调用：

notification.open({
  message: '趣谈前端React',
  description: '学前端，学React/vue/Node，快快加入我们吧'
});
  • 1.
  • 2.
  • 3.
  • 4.

我们看到的组件效果可能是这样的：

那么我们如何实现这样的调用方式呢?不用急，接下来笔者会一步步教你实现。

先来巩固以下组件的分类法：

  • 通用型组件: 比如Button, Icon等；
  • 布局型组件: 比如Grid, Layout布局等；
  • 导航型组件: 比如面包屑Breadcrumb, 下拉菜单Dropdown, 菜单Menu等；
  • 数据录入型组件: 比如form表单, Switch开关, Upload文件上传等；
  • 数据展示型组件: 比如Avator头像, Table表格, List列表等；
  • 反馈型组件: 比如Progress进度条, Drawer抽屉, Modal对话框等；
  • 其他业务类型。

熟悉以上分类法是设计任何组件系统的前提，不管你是从零到一开发前端团队的UI库，还是基于已有组件库二次开发业务组件，以上分类法则同样适用。本文将会使用React来开发该组件，也会使用到Javascript中常用的一些设计模式，比如单例模式，但是不管你使用什么框架来实现，原理都是通用的，如果感兴趣的朋友可以用vue也实现以一下。

正文

在开始组件设计之前希望大家对css3和js有一定的基础,并了解基本的react/vue语法.我们先来解构一下Notification组件, 一个Notification分为以下几个部分：

每一个区块都可以自定义配置, 也可以组合其他组件.并且我们可以配置提醒框出现的位置，就像antd的组件一样，我们有左上，左下，右上，右下这几个位置可以配置，也可以配置基于这几个位置的偏移量。并且我们都知道，antd或者element这种组件库，会自带一些主题状态，来提高用户的使用效率，比如会有success(成功状态)，warning(警告状态)，error(错误状态)，info(通知状态)等，那么我们自己实现的组件也因该具备这些功能。

以下是笔者使用React实现后的Notification组件效果：

接下来我们来看看通知提醒框(Notification)的具体设计思路。

1. Notification组件设计思路

按照之前笔者总结的组件设计原则,我们第一步是要确认需求. 通知提醒框(Notification)组件一般会有如下需求点:

  • 能控制Notification自动关闭的时间
  • 能配置Notification渲染节点的输出位置
  • 能控制Notification的弹出位置
  • 能自定义关闭图标
  • 可以手动选择通知窗类型
  • 能自定义通知框的偏移量
  • 能设置通知框的信息和提示文本
  • 能自定义通知框的Icon
  • 通知框点击时提供回调函数
  • 通知框关闭时提供回调函数
  • 能手动销毁通知框

需求收集好之后,作为一个有追求的程序员, 会得出如下线框图：

其实通知提醒框要考虑的东西挺多的，所以在设计组件之前，一定要想理清需求和功能划分，这样才能有条不絮的去实现它，和我们实现一个复杂系统是一样的，一个组件就是一个小系统。

2. 基于react实现一个通知提醒框(Notification)

通知框的API调用实现思路其实就是通过jsx动态渲染约定好的标签，然后通过ReactDom的Render API将dom渲染到指定容器内挂载到页面，其中要想实现Notification.info这样的方式还需要考虑到创建实例的问题，我们应该使用单例模式来控制实例的创建个数。伪代码如下：

const xNotification = (function() {
    let notification = null;
    if(notification) {
        return {
            render(dom){},
            config(config){},
            info(config){},
            error(config){}
            // ...
        }
    }else {
        notification = new Notification({})
        return {
            render(dom){},
            config(config){},
            info(config){},
            error(config){}
            // ...
        }
    }
})()
// 使用
xNotification.info({...})
xNotification.error({...})
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.

但是真正要实现以上需求讨论的那些通知框的功能，实际上我们还是要写很多代码来处理不同的情况的，所以为了方便大家理解，我们这里使用React Notification这个第三方库来帮我们处理基本的逻辑，笔者会基于它，来实现上面我们讨论的那些功能。

2.1 搭建通知提醒框(Notification)的基本骨架

首先按照笔者的代码风格，一般会考虑组件设计的框架，然后再一步步往里面填充内容和逻辑。通过这种渐进式的设计思路，能让我们逻辑更严谨，更清晰。具体代码如下：

import Notification from 'rc-notification'
import './index.less'

const xNotification = (function() {
  let notification = null
  /**
     * notice类型弹窗
     * @param {config}  object 通知框配置属性
     *   @param {type} string 通知窗类型
     *   @param {btn}  ReactNode 自定义关闭按钮
     *   @param {bottom}  number 消息从底部弹出时，距离底部的位置，单位像素
     *   @param {className}  string 自定义 CSS class
     *   @param {description}  string|ReactNode 通知提醒内容，必选
     *   @param {duration}  number 默认 4.5 秒后自动关闭，配置为 null 则不自动关闭
     *   @param {getContainer}  HTMLNode 配置渲染节点的输出位置
     *   @param {icon}  ReactNode 自定义图标
     *   @param {key}  string 当前通知唯一标志
     *   @param {message}  string|ReactNode 通知提醒标题，必选
     *   @param {onClose}  func 点击默认关闭按钮时触发的回调函数
     *   @param {onClick}  func 点击通知时触发的回调函数
     *   @param {top}  number 消息从顶部弹出时，距离顶部的位置，单位像素
     *   @param {closeIcon}  ReactNode 自定义关闭图标
     */
  const pop = (config) => {
    const {
      type, bottom, className, description, duration = 4.5,
      getContainer = () => document.body, icon, 
      key, message, onClose, onClick, top, closable = true, closeIcon
    } = config
    notification.notice({
      content: <div className={classnames('xNotice', className )}>
        <div className={classnames('iconWrap', type)}>
            <Icon type={iconType[type]} />
        </div>
        <div>
          <div className="xNoticeTit">
            { message }
          </div>
          <div className="xNoticeDesc">
            { description }
          </div>
        </div>
      </div>
    })
  }
  /**
     * 通知提示组件, 全局参数
     * @param {bottom} number 消息从底部弹出时，距离底部的位置，单位像素， 默认24
     * @param {duration} number 默认自动关闭延时，单位秒
     * @param {getContainer} HTMLNode 配置渲染节点的输出位置，默认document.body
     * @param {placement} string 弹出位置，可选 topLeft topRight bottomLeft bottomRight
     * @param {top} number 消息从顶部弹出时，距离顶部的位置，单位像素
     * @param {closeIcon} HTMLNode 自定义关闭图标
  */
  const config = (config) => {
    const { duration, getContainer, placement, closeIcon } = config
    Notification.newInstance({
      getContainer: getContainer,
      duration: duration || 4.5,
      closeIcon
    }, (notice) => notification = notice)
  }

  if(notification) {
    return {
      config,
      pop
    }
  }
  // 如果为创建实例，则创建默认实例
  Notification.newInstance({}, (notice) => notification = notice)
  return {
    config,
    pop
  }
})()

export default xNotification
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36.
  • 37.
  • 38.
  • 39.
  • 40.
  • 41.
  • 42.
  • 43.
  • 44.
  • 45.
  • 46.
  • 47.
  • 48.
  • 49.
  • 50.
  • 51.
  • 52.
  • 53.
  • 54.
  • 55.
  • 56.
  • 57.
  • 58.
  • 59.
  • 60.
  • 61.
  • 62.
  • 63.
  • 64.
  • 65.
  • 66.
  • 67.
  • 68.
  • 69.
  • 70.
  • 71.
  • 72.
  • 73.
  • 74.
  • 75.
  • 76.
  • 77.
  • 78.

首先我们根据需求把一项项的属性都罗列出来。我们在全局使用的配置方法是xNotification.config(config), 在通知框实例中我们使用xNotification.pop(config)。这点和antd的使用方式有点不同，笔者是把通知框类型放到pop的config来处理了，比如说要渲染一个成功的通知框，我们可以这么做：

xNotification.pop({type: 'success'})
  • 1.

antd同样的方式会这么调用：

// antd
Notification.info({//...})
  • 1.
  • 2.

笔者之所以会这么做是因为info，success，warning这样的状态其实dom结构完全可以复用，所以通过配置方式可以极大的减少冗余代码。

2.2 实现通知框类型type和自定义icon

笔者其实在搭建组件框架的时候已经完成了部分属性的配置，所以这里就不一一介绍了，笔者将会介绍一些比较重要的方法的实现。

通过观察我们可以知道要想实现不同的通知框类型，只需要根据类型来动态替换icon就行了。icon图标部分采用笔者已经实现的Icon组件，具体用法和antd的Icon组件类似，如果想学习如何封装属于自己的Icon组件可以参考笔者源码。

首先我们先定义一个类型和icon的映射关系：

const iconType = {
    success: 'FaRegCheckCircle',
    warning: 'FaRegMeh',
    info: 'FaRegLightbulb',
    error: 'FaRegTimesCircle'
 }
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

这四种类型对应着不同的icon图标类型，那么我们就可以根据用户传入的类型来展示不同icon图标了：

<div className={classnames('iconWrap', type)}>
    <Icon type={iconType[type]} />
</div>
  • 1.
  • 2.
  • 3.

不过我们还需要考虑的一点就是如果用户传入了自定义的icon，我们理论上应该展示自定义icon，所以type因该和icon这两个属性是有联系的。还有一种情况就是如果用户即没有配置type，有没有传入icon，那么实际上是不需要显示icon的，综合考虑之后我们的代码如下：

{
  (icon || ['info', 'success', 'error', 'warning'].indexOf(type) > -1) &&
  <div className={classnames('iconWrap', type)}>
    {
      icon ? icon : <Icon type={iconType[type]} />
    }
  </div>

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.

实现效果如下图：

2.3 通知框位置placement

通知框的位置根据业务场景来看因该是全局配置，所以我们放在config方法里设置，关于如何根据用户传入的位置信息来控制Notification显示的位置，我们也可以先定义一个枚举类：

const adapterPos = {
    topLeft: {
      top: '24px',
      left: '24px'
    },
    topRight: {
      top: '24px',
      right: '24px'
    },
    bottomLeft: {
      bottom: '24px',
      left: '24px'
    },
    bottomRight: {
      bottom: '24px',
      right: '24px'
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.

从上面代码可以看到我们会定义四个基础位置，默认偏移都是24px，然后我们就可以根据用处传入的placement来匹配自己的位置信息了：

Notification.newInstance({
  style: {...adapterPos[placement] },
  // ...
  • 1.
  • 2.
  • 3.

上面代码可以知道位置信息我们是通过style来设置的。具体效果如下：

2.4 实现通知框动画效果

动画我们实现一个类似于antd的从右往左入场的动画，我们来改写样式如下：

.rc-notification-fade-enter {
    animation: moveLeft .3s;
}
.rc-notification-fade-leave {
    animation: moveOutLeft .3s;
}
.rc-notification-fade-enter.rc-notification-fade-enter-active {
    animation: moveLeft .3s;
}
.rc-notification-fade-leave.rc-notification-fade-leave-active {
    animation-name: moveOutLeft .3s;
}

@keyframes moveOutLeft {
    0% {

    }
    100% {
        right: -200%;
    }
}
@keyframes moveLeft {
    0% {
        right: -200%;
    }
    100% {
        right: 0;
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.

通过以上步骤, 一个功能强大的通知提醒框(Notification)就完成了.Notification组件算是组件库中中等复杂的组件，如果不懂的可以在评论区提问,笔者看到后会第一时间解答。

2.5 使用Notification组件

我们可以通过如下方式使用它：

<Button type="primary" onClick={
    () => {
        xNotification.pop({
            type: 'success',
            message: '趣谈前端学习打卡',
            description: '前端基础，中级进阶，高级打卡，一起玩转前端，996远离你'
        })
    }
}>点我显示通知</Button>
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.

配置全局属性：

import { xNotification } from '@alex_xu/xui'

xNotification.config({
    placement: 'topRight'
})
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.

笔者已经将实现过的组件发布到npm上了,大家如果感兴趣可以直接用npm安装后使用,方式如下；

pm i @alex_xu/xui

// 导入xui
import {
  Button,
  Skeleton,
  Empty,
  Progress,
  Tag,
  Switch,
  Drawer,
  Badge,
  Alert
} from '@alex_xu/xui'
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.

该组件库支持按需导入,我们只需要在项目里配置babel-plugin-import即可,具体配置如下:

/ .babelrc
"plugins": [
  ["import", { "libraryName": "@alex_xu/xui", "style": true }]
]
  • 1.
  • 2.
  • 3.
  • 4.

npm库截图如下：

如何两天时间上线一款AI应用？
用自己的编程语言实现了一个网站（增强版）