1. 你不知道的element-ui之v-clickoutside

134 阅读2分钟

前言

不知道大家在开发中是否遇到过,当页面某一区域失焦或者其他区域进行点击时需要做一些事情,以往很多时候我们都有各种各样的方法去解决这类问题,今天带给大家的是element-ui源码中解决此类问题较为合适的方案v-clickoutside,接下来我们就一起去看看吧。

源码解析

在开始之前,我们先看看element-ui哪些部分有类似于上面的场景,比如时间框组件和ColorPicker组件,都有这类场景,那我们就先去看看吧 在时间框组件源码中,我们能很清晰的看到v-clickoutside的应用,应用还是很简单的,作为指令绑定一个函数就可以在组件失焦或者页面上点击所绑定指令元素其他的区域时,触发对应函数,那他具体是怎么做的呢,这就需要看源码了

import Vue from 'vue';
import { on } from 'element-ui/src/utils/dom';

const nodeList = []; // nodeList 是 当前页面绑定过v-clickoutside指令的dom集合
const ctx = '@@clickoutsideContext'; // 一个标识,用来从对应dom上取相关方法属性

let startClick;
let seed = 0;
// 下面两行是事件的绑定
!Vue.prototype.$isServer && on(document, 'mousedown', e => (startClick = e));

!Vue.prototype.$isServer && on(document, 'mouseup', e => {
  nodeList.forEach(node => node[ctx].documentHandler(e, startClick));
});
// 创建页面点击时,每个绑定过clickoutside的el需要执行的函数
function createDocumentHandler(el, binding, vnode) {
  return function(mouseup = {}, mousedown = {}) {
    if (!vnode ||
      !vnode.context ||
      !mouseup.target ||
      !mousedown.target ||
      el.contains(mouseup.target) ||
      el.contains(mousedown.target) ||
      el === mouseup.target ||
      (vnode.context.popperElm &&
      (vnode.context.popperElm.contains(mouseup.target) ||
      vnode.context.popperElm.contains(mousedown.target)))) return;

    if (binding.expression &&
      el[ctx].methodName &&
      vnode.context[el[ctx].methodName]) {
      vnode.context[el[ctx].methodName]();
    } else {
      el[ctx].bindingFn && el[ctx].bindingFn();
    }
  };
}

/**
 * v-clickoutside
 * @desc 点击元素外面才会触发的事件
 * @example
 * ```vue
 * <div v-element-clickoutside="handleClose">
 * ```
 */
export default {
  bind(el, binding, vnode) {
    nodeList.push(el);
    const id = seed++;
    el[ctx] = {
      id,
      documentHandler: createDocumentHandler(el, binding, vnode),
      methodName: binding.expression,
      bindingFn: binding.value
    };
  },

  update(el, binding, vnode) {
    el[ctx].documentHandler = createDocumentHandler(el, binding, vnode);
    el[ctx].methodName = binding.expression;
    el[ctx].bindingFn = binding.value;
  },

  unbind(el) {
    let len = nodeList.length;

    for (let i = 0; i < len; i++) {
      if (nodeList[i][ctx].id === el[ctx].id) {
        nodeList.splice(i, 1);
        break;
      }
    }
    delete el[ctx];
  }
};

从上方代码我们可以看出,element主要做了以下几件事情

  1. 创建全局的事件监听函数

  2. 在每次v-clickoutside绑定时,将当前元素缓存下来,并且在元素上存储对应的属性

  3. 在每次页面点击时,批量之下nodeList中的函数