vue 指令

Vue 提供了很多指令，如：v-model, v-show，v-if等等，有利于应付开发时出现的各种情况。Vue 也提供了自定义指令，有利于开发者将某些通用性功能封装成一个指令，进行全局或局部注册。如：复制指令（copy），聚焦指令（focus）。vue2 与 vue3 指令的创建与注册都有不同的。
只有当所需功能只能通过直接的 DOM 操作来实现时，才应该使用自定义指令。

vue2

注册自定义指令的方式

• 全局注册自定义指令

// 如果是用 cli 搭建的项目，在main.js文件下注册一个 focus指令
Vue.directive('focus', {
  inserted: function (el) {
    el.focus();
  },
});

• 局部注册自定义指令

export default {
    name: 'App',
    components: {},
  // 指令
    directives: {
      focus: {
        inserted: function (el) {
          el.focus();
        },
      },
  },
};

指令的使用

<template>
<!--  使用自定义指令 v-focus  -->
  <input v-focus />
</template>

可以看到上面自定义focus，使用时需要加上v-前缀。

指令的钩子函数

• bind：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
• inserted：被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)。
• update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有
• 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 钩子中可用。

注意：处理 el外，不同钩子直接要进行数据共享，请使用dataset。

vue3

setup 的情况

在 script上有 setup情况下， 以v开头的驼峰命令变量就会自动注册为指令。

• 注册局部指令

<script setup>
  const vFocus = {
    mounted: (el: any) => el.focus(),
  };
</script>

没有setup 的情况

• 局部注册

<script>
  export default {
  setup() {
    /*...*/
  },
  directives: {
    // 在模板中启用 v-focus
    focus: {
      /* ... */
    }
  }
}
</script>

全局注册

上面介绍了在有没有setup的情况下，局部注册指令。全局注册指令是上面两种情况共有的。

const app = createApp({})

// 使 v-focus 在所有组件中都可用
app.directive('focus', {
  /* ... */
})

指令钩子函数

指令钩子函数都是可选的。如上面的 focus指令只使用了mounted钩子

const myDirective = {
  // 在绑定元素的 attribute 前
  // 或事件监听器应用前调用
  created(el, binding, vnode, prevVnode) {
    // 下面会介绍各个参数的细节
  },
  // 在元素被插入到 DOM 前调用
  beforeMount(el, binding, vnode, prevVnode) {},
  // 在绑定元素的父组件
  // 及他自己的所有子节点都挂载完成后调用
  mounted(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件更新前调用
  beforeUpdate(el, binding, vnode, prevVnode) {},
  // 在绑定元素的父组件
  // 及他自己的所有子节点都更新后调用
  updated(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件卸载前调用
  beforeUnmount(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件卸载后调用
  unmounted(el, binding, vnode, prevVnode) {}
}

指令钩子函数的参数

• el：指令绑定到的元素。这可以用于直接操作 DOM。
• binding：一个对象，包含以下属性。
  • value：传递给指令的值。例如在 v-my-directive=“1 + 1” 中，值是 2。
  • oldValue：之前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否更改，它都可用。
  • arg：传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中，参数是 “foo”。
  • modifiers：一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中，修饰符对象是 { foo: true, bar: true }。
  • instance：使用该指令的组件实例。
  • dir：指令的定义对象。
• vnode：代表绑定元素的底层 VNode。
• prevNode：之前的渲染中代表指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。

指令的使用

<template>
<!--  使用自定义指令 v-focus  -->
  <input v-focus />
</template>

vue2 与 vue3 之间 指令的对比

• 注册方式不一样，选项式的注册方式基本相同，vue3 多了一个setup 情况下注册指令。
• vue2 与 vue3 的指令钩子不一样，vue3 的指令钩子像组件生命周期
• 两个版本都是除el参数外，其他参数应该为只读状态，如果钩子之间需要数据共享，可以采用dataset的方式。

参考文章

1. Vue2 自定义指令
2. Vue3 自定义指令