opig

Vue自定义指令

7/20/2022 Vue2.0

# 什么是自定义指令

除了核心功能默认内置的指令 (v-model 和 v-show)，Vue 也允许注册自定义指令,对普通 DOM元素进行底层操作，这时候就会用到自定义指令。
1
# 如何自定义指令
  • 自定义指令分为全局自定义指令和局部自定义指令
# 自定义指令的钩子函数
  1. bing : 只调用一次，指令第一次绑定带元素时调用。在这里可以进行一次性的初始化功能
  2. inserted : 被绑定元素插入父节点时调用
  3. update : 所有组件VNode更新时调用，但是可能发生在其子VNode更新之前，
  4. componentUpdated 指令所在组件的VNode及VN全部更新后调用
  5. unbind : 只调用一次，指令与元素解绑时调用
# 全局组件
// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
  // 当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})
1
2
3
4
5
6
7
8
# 局部自定义组件
directives: {
  focus: {
    // 指令的定义
    inserted: function (el) {
      el.focus()
    }
  }
}
1
2
3
4
5
6
7
8
# 使用的时候要在自定义的指令前面加上v-,然后你可以在模板中任何元素上使用新的 v-focus
<input v-focus></input>
1
# 指令钩子函数会被传入以下参数：钩子函数的参数
el：指令所绑定的元素，可以用来直接操作 DOM。
binding：一个对象，包含以下 property：
name：指令名，不包括 v- 前缀。
value：指令的绑定值，例如：v-my-directive="1 + 1" 中，绑定值为 2。
oldValue：指令绑定的前一个值，仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
expression：字符串形式的指令表达式。例如 v-my-directive="1 + 1" 中，表达式为 "1 + 1"。
arg：传给指令的参数，可选。例如 v-my-directive:foo 中，参数为 "foo"。
modifiers：一个包含修饰符的对象。例如：v-my-directive.foo.bar 中，修饰符对象为 { foo: true, bar: true }。
vnode：Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
除了 el 之外，其它参数都应该是只读的，切勿进行修改。如果需要在钩子之间共享数据，建议通过元素的 dataset 来进行。
1
2
3
4
5
6
7
8
9
10
11
# 例如
Vue.directive("focus", {
  bind: (el, binding) => {
    console.log("a");
    console.log(el, binding);
  },
});
1
2
3
4
5
6
# 一些自定义指令的应用场景：
防抖、图片懒加载、一键 Copy的功能、拖拽、页面水印、权限校验、输入框自动聚焦、相对时间转换、下拉菜单
1