奇技淫巧——element-ui组件"无损"拓展自身能力

说明:"无损"指的是无需修改源码。

背景

element-ui相信大家都用过,在一些大的团队还会基于element-ui做二次开发,拓展其能力或者开发一些垂直场景下的业务组件。在使用这类组件库的过程中是否遇到原组件能力不支持,比如缺少prop,event,甚至是一些额外function。笔者在开发过程中就经常遇到此类场景,想要一个属性或方法,在官方文档里找了一遍又一遍,却一无所获。

此时一般会有两种方案:

方案一:copy 组件源码,在项目里创建一个Customxxx,在原有组件的基础上拓展其能力 方案二:去社区里找找有没有平替的组件,npm install下来使用

上面两种方案可以解决问题,但是成本就有点高了。

这次给大家介绍第三种方法,无需修改element-ui的源码,而可以直接拓展现有组件的能力!

PS:本方法属于取巧手段,根据本人经验大约能解决70~80%的问题场景

原理

我们都知道Vue在初始化组件时,会通过new Vue()或Vue.extend()创建实例,并将组件选项(如data、methods、computed等)挂载到该实例上。此时,Vue通过隐式绑定 确保在组件方法中可以调用this拿到当前组件的实例。

并且为了方便开发者操作子组件,还贴心地提供了ref API。

本文提到的第三种方案就是借助Vue的这个特性,回归到最原始的方法,去感知组件内部状态的变化,从而拓展组件的能力!

分析思路如下

组件对外能力由属性(prop)+行为(action)体现

=> 拓展现有能力 === 拓展prop或action

=> 拓展prop(需修改代码)

=> 拓展action ≈ 增加或拓展 method或event

=> 增加(需修改代码)

=> 拓展?

如何拓展呢?很简单,方法劫持!并且需要回归使用最朴素的劫持方式,闭包!

为什么不能是 Proxy?

Proxy 对象用于创建一个对象的代理,从而实现基本操作的拦截和自定义(如属性查找、赋值、枚举、函数调用等)。

因为Vue调用的是原始对象,无法篡改为代理对象...

实践

以项目中实际使用的一个例子为demo给大家演示上述方案。

如下图所示,element-ui的Menu在折叠状态提供了自动弹出SubMenu的能力。

在笔者的场景中需要"感知"弹出的 SubMenu收起动作,查阅了一遍官方文档没有找到类似的event。因此打算拿到 SubMenu的实例,采用劫持实例方法的方式拓展其能力。

找到待劫持的方法

怎么找呢?

没有什么技巧,就是去查阅组件源码。Searching源码...

发现其实SubMenu监听了onmouseleave事件,在该事件回调里完成了submenu popover的销毁。贴上handleMouseleave的代码:

js 复制代码
   handleMouseleave(deepDispatch = false) {
        const {rootMenu} = this;
        if (
          (rootMenu.menuTrigger === 'click' && rootMenu.mode === 'horizontal') ||
          (!rootMenu.collapse && rootMenu.mode === 'vertical')
        ) {
          return;
        }
        this.dispatch('ElSubmenu', 'mouse-leave-child');
        clearTimeout(this.timeout);
        this.timeout = setTimeout(() => {
          !this.mouseInChild && this.rootMenu.closeMenu(this.index);
        }, this.hideTimeout);

        if (this.appendToBody && deepDispatch) {
          if (this.$parent.$options.name === 'ElSubmenu') {
            this.$parent.handleMouseleave(true);
          }
        }
      },

找到了目标方法,那就好办了,下一步便是劫持该方法,添加自己需要的逻辑。

劫持方法,emit事件

js 复制代码
mounted() {
    this.$emit('mounted', true)

    // 劫持 el-submenu 的handleMouseleave方法,以监听 mouse-leave-child 事件
    this.$ref.submenus.forEach(comp => {
      const originFunc = comp.handleMouseleave
      comp.handleMouseleave = (...args) => {
        this.$emit('mouse-leave-child', { index: comp.index, isMenuPopup: comp.isMenuPopup })
        // 重要!!!调用原方法,触发原有逻辑
        originFunc.apply(comp, args)
      }
    })
  }

通过上面的代码,可以成功将mouse-leave-child事件抛出来,方便做进一步的处理。此处略过具体的事件回调方法代码。 怎么样?是不是很简单,hhh

总结

  1. 组件库现有组件难免会出现不满足需求的情况,需要拓展其能力;
  2. 拓展现有组件能力一个方法是全盘copy源码,在源码级别上进行重写、拓展,但缺点是需要连带copy组件的关联文件,产生大量冗余代码;
  3. 本文提供了一种新的拓展组件能力的思路,即用朴素的方法劫持思想,劫持现有组件的方法,对其进行拓展,从而达到无损拓展组件能力的目的。
相关推荐
kyriewen1 天前
编辑弹窗点了取消,列表里的数据怎么还是变了?
前端·javascript·人工智能
Karl_fang1 天前
🥳 再也不用拿起手机抄验证码!我做了一个 Android → Mac 的「验证码接力」工具
前端·macos·ai编程
谭光志1 天前
如何让 AI 高效工作
前端·后端·ai编程
FRing031 天前
vue2干货总结11(短信验证、登录功能、统一处理错误(响应拦截器)、将token信息存入vuex、vuex持久化处理)
开发语言·前端·javascript·vue.js·vue2
泯泷1 天前
改一个字,整段都红了?——中文内容差异对比的算法与协议设计
前端·javascript·typescript
再吃一根胡萝卜1 天前
DSH plugin 开发示例:五种插件形态完整代码整理
前端
Yk酱228401 天前
A2UI随笔-demo-01
前端
云起SAAS1 天前
本地生活同城多商户商城系统源码源码 合伙人分红加区域代理加排队返现
前端·javascript·后端
奶油话梅糖1 天前
3 天 1,705 Star:DeepSeek 开源官方聊天前端——零后端纯静态,浏览器直连 API
前端·开源
Linye1 天前
HTML 流程图连线交叉看不清?聊聊画布避障折线与跳弧实现
前端·人工智能