读v-click-outside源码

v-click-outside介绍

v-click-outside github地址

使用在Vue中的插件,一个附加的指令插件,作用是:

  1. 点击指定元素外的区域可以触发事件
  2. 可以绑定多个元素,一个元素上可以绑定多个事件
  3. 有中间件的概念,其实也就是个拦截器

核心实现代码

function onEvent({ el, event, handler, middleware }) {
  // 判断点击事件触发的元素(event.target)是否是绑定元素(el)的子元素
  const isClickOutside = event.target !== el && !el.contains(event.target)
  // 如果不是外部则不触发
  if (!isClickOutside) {
    return
  }
  // middleware是中间件(拦截器),根据返回值可以决定是否拦截,同时还会执行middleware内部的代码
  if (middleware(event, el)) {
    // 绑定的点击元素外区域的触发函数
    handler(event, el)
  }
}

创建触发事件的实例

对其中的参数和格式做处理,为简化后续创建,处理后是一个对象,里面包含el当前绑定元素和eventHandlers绑定事件的数组列表

eventHandlers中每个对象又包含event事件名和handler事件处理函数

  • el:绑定事件的元素
  • events:数组,可以绑定多个事件,比如:blur,foucs等,默认是click(PC),移动端是click和tap
  • handler:绑定的事件触发的函数
  • middleware:中间件
function createInstance({ el, events, handler, middleware }) {
  return {
    el,
    eventHandlers: events.map((eventName) => ({
      event: eventName,
      handler: (event) => onEvent({ event, el, handler, middleware }),
    })),
  }
}

初始化实例并绑定

这里面有2个小细节:

  1. 采用定时器注册事件,实现类似异步注册,提高效率
  2. 将创建好的实例存放在数组缓存为后续注销和修改使用
function bind(el, { value }) {
  // 处理参数和初始值问题
  const { events, handler, middleware, isActive } = processDirectiveArguments(value)
  // 是否可用的开关
  if (!isActive) {
    return
  }
  // 初始化实例
  const instance = createInstance({ el, events, handler, middleware })
  // 根据初始化后的实例,去循环绑定指定的事件和事件处理函数
  instance.eventHandlers.forEach(({ event, handler }) =>
    setTimeout(() => document.addEventListener(event, handler), 0),
  )
  // 存放在数组缓存中
  directive.instances.push(instance)
}

注销已初始化的实例

有两点注意:

  1. 注销事件时,不能用setTimeout,因为需要同步全部注销完后做清除缓存实例的动作
  2. removeEventListener中的处理函数必须用addEventListener中的处理函数,所以这里缓存就起到作用了,如果只是单纯的函数一样是没办法注销的
function removeInstance(el) {
  // 读取缓存中el的实例
  const instanceIndex = directive.instances.findIndex((instance) => instance.el === el)
  // 如果不存在实例则停止注销
  if (instanceIndex === -1) {
    // Note: This can happen when active status changes from false to false
    return
  }
  // 缓存中el的实例
  const instance = directive.instances[instanceIndex]
  // 循环注销
  instance.eventHandlers.forEach(({ event, handler }) =>
    document.removeEventListener(event, handler),
  )
  // 清除缓存中的注销实例
  directive.instances.splice(instanceIndex, 1)
}

解读源码的原因

由于v-click-outside只能在Vue中以指令的,但是有时候可能用不了指令,比如动态生成的元素,也有可能不是在Vue中想要用到,所以通过读源码开发一个原生js库

最后发布了:

outside-click-js npm库

outside-click-js github地址

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容

  • vue概述 在官方文档中,有一句话对Vue的定位说的很明确:Vue.js 的核心是一个允许采用简洁的模板语法来声明...
    li4065阅读 7,108评论 0 25
  •   JavaScript 与 HTML 之间的交互是通过事件实现的。   事件,就是文档或浏览器窗口中发生的一些特...
    霜天晓阅读 3,424评论 1 11
  • 主要还是自己看的,所有内容来自官方文档。 介绍 Vue.js 是什么 Vue (读音 /vjuː/,类似于 vie...
    Leonzai阅读 3,269评论 0 25
  • 第一章 Vue概述 what? Vue是实现UI层的渐进式js框架,核心库关注视图层,简单的ui构建,复杂的路由控...
    fastwe阅读 647评论 0 0
  • 第3章 基本概念 3.1 语法 3.2 关键字和保留字 3.3 变量 3.4 数据类型 5种简单数据类型:Unde...
    RickCole阅读 5,037评论 0 21