1.前言

最近遇到一个需要，公司须要做一个相似facebook的搜寻抉择组件，我打算用el-input和el-cascader-panel联合设计。在设计过程中参考了el-cascader的源码，其中的v-clickoutside自定义指令蛮值得钻研的，所以写篇文章记录下。

2.根底知识点

（1）v-directive

vue文档曾经写的很分明了，这里只贴网址：vue中文文档-自定义指令

（2）v-clickoutside

先放element-ui中的源码

//element-ui/src/utils/clickoutside.jsimport Vue from 'vue';import { on } from 'element-ui/src/utils/dom';const nodeList = [];const ctx = '@@clickoutsideContext';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));});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-ui/src/utils/domexport const on = (function() {  if (!isServer && document.addEventListener) {    return function(element, event, handler) {      if (element && event && handler) {        element.addEventListener(event, handler, false);      }    };  } else {    return function(element, event, handler) {      if (element && event && handler) {        element.attachEvent('on' + event, handler);      }    };  }})();

v-clickoutside用于解决指标节点外的点击事件，最次要的是下拉框等开展内容的敞开。

这道程序应用了订阅公布的设计模式，先通过自定义的on办法（兼容addEventListener和attachEvent两个绑定办法的函数），在document中绑定mouseup和mousedown事件，两个事件别离记录鼠标按下和松开时所在的节点，之后与指标节点进行比照，如果点击元素是指标节点或者被指标节点蕴含在内，则触发对应的执行函数。

在执行bind周期函数时，先把该元素寄存在nodeList中，且在元素中赋值一个名为“@@clickoutsideContext”的属性，这个对象外面别离寄存id(用于标记元素，不便unbind周期函数中把元素从nodeList中剔除)，documentHandler(寄存执行函数)，methodName(binding.expression)，bindingFn(binding.value)。

当执行到update周期函数时，会对el中的ctx属性进行更新。执行unbind函数时，会依据el中的ctx属性中记录的id去剔除本对象。

createDocumentHandler函数会返回一个能通过闭包拜访到mouseup(鼠标按下时所在的元素)和mousedown(鼠标松开时所在的元素)的函数，该函数执行时会依照以下条件判断v-clickoutside中绑定的函数是否执行：

  1. !vnode || !vnode.context || !mouseup.target || !mousedown.target :判断vnode和vnode.context等指标是否存在
  2. el.contains(mouseup.target) || el.contains(mousedown.target) || el === mouseup.target：判断以后指标节点是鼠标松开时所在的节点，或者是否蕴含鼠标点击或者鼠标松开时所在的元素
  3. (vnode.context.popperElm &(vnode.context.popperElm.contains(mouseup.target) || vnode.context.popperElm.contains(mousedown.target)))：判断虚构节点vnode中的popperElm，也就是是否存在悬浮的组件上。

当合乎下面任一条件时，函数就会return，否则执行所绑定指标节点中寄存在名为“@@clickoutsideContext”属性的执行办法。

3.源码的改良

剖析：集体感觉el[ctx]这个设计的存在可能是便于其余作用域拜访以后el所绑定的执行函数而设计的。基于我的状况，次要围绕把el[ctx]为出发点，把nodeList改成了以Map的（key,value）作保留，改良如下：

let clickInEventlet nodeEventRecorder = new Map()document.addEventListener('mousedown', e => (clickInEvent = e))document.addEventListener('mouseup', e => {  nodeEventRecorder.forEach((value) => {    value(e, clickInEvent)  })})function createHandler (el, binding, vnode) {  return function (mouseup = {}, mousedown = {}) {    if (!vnode ||      !vnode.context ||      !mouseup.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 && vnode.context[binding.expression]) {      vnode.context[binding.expression]()    } else {      if (typeof (binding.value) === 'function') {        binding.value()      } else {        throw new Error('value should be a function')      }    }  }}let directive = {  bind (el, binding, vnode) {    nodeEventRecorder.set(el, createHandler(el, binding, vnode))  },  update (el, binding, vnode) {    nodeEventRecorder.set(el, createHandler(el, binding, vnode))  },  unbind (el) {    nodeEventRecorder.delete(el)  }}export default directive

有人会问为什么不必Object作为贮存映射的容器类型，那是因为Object的key只能是字符串或者Symbol类型的数据。而Map的Key能够是任何数据类型，包含节点。

用Map替换后也不存在el[ctx]和seed++这类变量了。在unbind中执行删除操作时也不须要遍历列表这么麻烦了。

实现的成果如下：