【分析element-ui源码】v-clickoutside指令

【分析element-ui源码】v-clickoutside指令

知识点：绑定事件和解除事件

//dom.js 绑定事件
/* istanbul ignore next */
export const on = (
  function() {
  if (!isServer && document.addEventListener) {
    return function(element, event, handler) {
      if (element && event && handler) {
        element.addEventListener(event, handler, false);
      }
    };
  } else {
     // 兼容不支持 document.addEventListener，例如低版本IE
    return function(element, event, handler) {
      if (element && event && handler) {
        element.attachEvent('on' + event, handler);
      }
    };
  }
})();
//解除绑定
/* istanbul ignore next */
export const off = (function() {
  if (!isServer && document.removeEventListener) {
    return function(element, event, handler) {
      if (element && event) {
        element.removeEventListener(event, handler, false);
      }
    };
  } else {
     // 兼容不支持 document.addEventListener，例如低版本IE
    return function(element, event, handler) {
      if (element && event) {
        element.detachEvent('on' + event, handler);
      }
    };
  }
})();

v-clickoutside指令:

import Vue from 'vue';
import { on } from '@/utils/dom';
// nodeList 是一个元素搜集器，会将页面中所有绑定了clickoutside指令的dom元素存储起来
const nodeList = [];
// 而ctx定义了一个命名空间（必须比较特殊，防止和其它特性重名），后面会将它添加为元素el的properties，具体后面会分析到。
const ctx = '@@clickoutsideContext';

let startClick;
let seed = 0;
// 鼠标按下时 记录按下元素的事件对象
!Vue.prototype.$isServer && on(document, 'mousedown', e => (startClick = e));
// 鼠标松开时 遍历 nodeList 中的元素，执行 documentHandler
!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;
     // 找到对应的dom元素，从 nodeList 移除它
    for (let i = 0; i < len; i++) {
      if (nodeList[i][ctx].id === el[ctx].id) {
        nodeList.splice(i, 1);
        break;
      }
    }
     // 移除之前添加的自定义属性
    delete el[ctx];
  }
};
// 选择栏的 dom 是挂载到 body 下，导致在点击完选择项后被判断为区域外点击。
// 然后我发现源码里提供了一个选项解决这种问题。可以在使用指令的组件 data 里定义 popperElm 属性，它的值是一个 dom。

调用:

 <el-button  v-clickoutside="handleCloseOutSide" 
      >测试点击外面区域</el-button
    >