vue 自定义指令

Jioho 6/25/2020 Vue

先回顾 vue 的指令有哪些：vue 中有哪些指令作用是什么

官方文档：自定义指令 (opens new window)

# 自定义指令基本语法

参考 vue 的示例，写一个自动聚焦的指令

# 全局指令

inserted 是一个钩子函数，后面会提到

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

1
2
3
4
5
6
7
8

# 局部指令

在组件中定义一个 directives（和 methods 等同级）

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

1
2
3
4
5
6
7
8
9
10

# 指令使用

<input v-focus />

1

# 指令的钩子函数

一个指令定义对象可以提供如下几个钩子函数 (均为可选)：
刚才的示例我们用的钩子函数是 inserted

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

# 钩子函数的参数

摘自官方原话

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 钩子中可用。