抽离ElementUI源码的clickoutside全局指令

一、前言

    ElementUI是一款基于Vue的前端优秀开源组件，其框架内部的许多工具都是非常优秀，而且好用的，本文将从中抽离出该框架中的1个非常实用的全局指令。

二、正文

1、clickoutside.js  //点击被插入该指令的元素外的任意空白处，触发指令所绑定的方法。

import 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];
  }
};

2、dom.js //用于事件绑定，适用于所有主流浏览器以及IE浏览器的事件绑定，该文件中巧妙的运用了闭包，实现了clickoutside的事件绑定功能；

import Vue from 'vue';

const isServer = Vue.prototype.$isServer;

/* 绑定事件 */
export 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);
      }
    };
  }
})();

/* 解除事件绑定 */
export const off = (function() {
  if (!isServer && document.removeEventListener) {
    return function(element, event, handler) {
      if (element && event) {
        element.removeEventListener(event, handler, false);
      }
    };
  } else {
    return function(element, event, handler) {
      if (element && event) {
        element.detachEvent('on' + event, handler);
      }
    };
  }
})();

/* 事件执行1次就被解除 */
export const once = function(el, event, fn) {
  var listener = function() {
    if (fn) {
      fn.apply(this, arguments);
    }
    off(el, event, listener);
  };
  on(el, event, listener);
};

3、使用方法

    （1）将clickoutside文件与dom.js文件放在同级目录

      （2）在main.js中引入clickoutside.js，并进行全局组件注册

//main.js
import clickoutside from "@/assets/js/clickoutside";  //引入路径根据自己项目而定
Vue.directive("clickoutside",clickoutside);//全局注册指令 v-clickoutside

    （3）在项目中使用

<!- 直接用v-clickoutside绑定方法，即可在点击被插入元素之外的地方触发该方法 ->
<div v-clickoutside="yourMethod">
    <div>....</div>
</div>

三、总结

    此指令功能一般用于点击空白处关闭对话框或者下拉框等操作时使用。