Vue 自定义指令 - 码农教程

简要说明

除了核心功能默认内置的指令 (v-model 和 v-show)，Vue 也允许注册自定义指令。注意，在 Vue2.0 中，代码复用和抽象的主要形式是组件。然而，有的情况下，你仍然需要对普通 DOM 元素进行底层操作，这时候就会用到自定义指令。举个聚焦输入框的例子，如下：

// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
  // 指令的定义；当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})

如果想注册局部指令，组件中也接受一个 directives 的选项：

directives: {
  focus: {
    // 指令的定义
    inserted: function (el) {
      el.focus()
    }
  }
}

然后你可以在模板中任何元素上使用新的 v-focus property，如下：

<input v-focus>

钩子函数

一个自定义指令，均包含一些钩子函数，像 Vue 生命周期一样，指令也有生命周期

bind：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置
inserted：被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)
update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)
componentUpdated：指令所在组件的 VNode 及其子 VNode 全部更新后调用
unbind：只调用一次，指令与元素解绑时调用

以上钩子函数会被传入以下参数：

==el==：指令所绑定的元素，可以用来直接操作 DOM

==binding==：一个对象，包含以下几个 property，就不展开说了，官方文档描述的也详细

==vnode==：Vue 编译生成的虚拟节点

==oldVnode==：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用

实践：图片懒加载指令

做一个图片懒加载的指令 v-imgLazy，当图片出现在可视区域内，去加载图片

那么这里有一个非常香的 api 可以食用了 IntersectionObserver

IntersectionObserver 对象的 observe() 方法向IntersectionObserver对象监听的目标集合添加一个元素。一个监听者有一组阈值和一个根，但是可以监视多个目标元素，以查看这些目标元素可见区域的变化

简单来说可以监听 dom 元素进出可视区域，并且可以控制具体的变化

在 src 下新建 directive 用来存放自定义指令

directive/imgLazy.ts

// 引入默认图片
import baseImg from '@/assets/logo.png'

let timer: any = null
// 创建一个监听器
const observer = new IntersectionObserver(entries => {
  // entries 是所有被监听对象的集合
  entries.forEach((entry: any) => {
    if (entry.isIntersecting || entry.intersectionRatio > 0) {
      // 当被监听元素到临界值且未加载图片时触发
      !entry.target.isLoaded && showImage(entry.target, entry.target.data_src)
    }
  })
})
function showImage(el: any, imgSrc: any) {
  const img = new Image()
  img.src = imgSrc
  img.onload = () => {
    el.src = imgSrc
    el.isLoaded = true
  }
}

export default {
  inserted(el: any, binding: any, vnode: any) {
    clearTimeout(timer)
    // 初始化时展示默认图片
    el.src = baseImg
    // 将需要加载的图片地址绑定在dom上
    el.data_src = binding.value
    observer.observe(el)

    // 防抖，这里在组件卸载的时候停止监听
    const vm = vnode.context
    timer = setTimeout(() => {
      vm.$on('hook:beforeDestroy', () => {
        observer.disconnect()
      })
    }, 20)
  },

  // 图片更新触发
  update(el: any, binding: any) {
    el.isLoaded = false
    el.data_src = binding.value
  }
}

可在 main.ts 注册全局指令

import imgLazy from '@/directive/imgLazy'

Vue.directive('imgLazy', imgLazy)

也可以在需要的组件注册局部指令

import imgLazy from '@/directive/imgLazy'

export default {
  directives: {
    imgLazy
  }
}

然后就可以愉快地使用 v-imgLazy 玩耍啦（v-imgLazy="imgSrc"）绑定的值是图片地址

注意

IntersectionObserver 不兼容 IE，万恶的 IE 啊

如果想要兼容，只能通过计算的方式来判断是否进入可视区域了

博客地址：https://ainyi.com/94