VUE3 自定义指令

1. 概念

   1. 除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外，Vue 还允许你注册自定义的指令 (Custom Directives)。自定义指令主要是为了重用涉及普通元素的底层 DOM 访问的逻辑。

2. 指令钩子

   1. 一个指令的定义对象可以提供几种钩子函数 (都是可选的)：
   2. 示例

      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) {}
      }

3. 钩子参数

   1. 指令的钩子会传递以下几种参数：

      1. el：指令绑定到的元素。这可以用于直接操作 DOM。

      2. binding：一个对象，包含以下属性。

      3. value：传递给指令的值。例如在 v-my-directive="1 + 1" 中，值是 2。

      4. oldValue：之前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否更改，它都可用。

      5. arg：传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中，参数是 "foo"。

      6. modifiers：一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中，修饰符对象是 { foo: true, bar: true }。

      7. instance：使用该指令的组件实例。

      8. dir：指令的定义对象。

      9. vnode：代表绑定元素的底层 VNode。

      10. prevNode：代表之前的渲染中指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。

   2. 举例来说，像下面这样使用指令：

      <div v-example:foo.bar="baz">

      binding 参数会是一个这样的对象：

      {
        arg: 'foo',
        modifiers: { bar: true },
        value: /* `baz` 的值 */,
        oldValue: /* 上一次更新时 `baz` 的值 */
      }

4. 示例

   <script setup>
   import {ref} from 'vue'
   let example = ref({
     color:'red',
   })
   // 在模板中启用 v-example
   const vExample = {
     mounted:(el,binding)=>{
       // console.log(binding)
       el.style.color = binding.value.color
     }
   }
   </script>
   
   <template>
     <span v-example:args="example">span</span>
   </template>