vue3自定义指令批量注册

146 阅读3分钟

如何封装自定义指令

1、在vue2中自定义指令的钩子函数

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

2、在vue3中自定义指令的钩子函数

export default {
  name: 'focus', // 指令名称
  default: {
    created(el, binding, vnode) {
      // 在绑定元素的 attribute 前 
      // 或事件监听器应用前调用
    },
    beforeMount(el, binding, vnode) {
     // 在元素被插入到 DOM 前调用
    },
    mounted(el, binding, vnode) {
      // 在绑定元素的父组件 
      // 及他自己的所有子节点都挂载完成后调用
    },
    beforeUpdate(el, binding, vnode, prevVnode) {
      // 绑定元素的父组件更新前调用 
    },
    updated(el, binding, vnode, prevVnode) {
      // 在绑定元素的父组件 
      // 及他自己的所有子节点都更新后调用 
    },
    beforeUnmount(el, binding, vnode) {
      // 绑定元素的父组件卸载前调用
    }, 
    unmounted(el, binding, vnode) {
      // 绑定元素的父组件卸载后调用 
    }
  }
}

3、钩子函数中的参数以及vue2 -> vue3的新增参数

-   el:指令所绑定的元素,可以用来直接操作 DOM。

-   `binding`:一个对象,包含以下 property:
    -   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](https://v2.cn.vuejs.org/v2/api/#VNode-%E6%8E%A5%E5%8F%A3) 来了解更多详情。

-   oldVnode:上一个虚拟节点,仅在 `update` 和 `componentUpdated` 钩子中可用。

vue2 -> vue3 在binding对象中新增了

  • name:指令名,不包括 v- 前缀。
  • instance:使用该指令的组件实例。
  • dir:指令的定义对象。

vue2 -> vue3

  • 将oldVnode的命名修改成preVnode

批量注册自定义指令

1、创建新指令 这里以v-focus为例

image.png

2、将指令引入到index.js文件中,并添加到directives对象中

image.png

若后续需要创建全局指令,那么只需创建指令文件以及引入到index.js中引用即可,但是前提是需要在main.js(主文件)中通过vue.use(v2)或者是 app.use(v3),来调用此处的install函数,点击了解use方法

3、在main.js中使用directives应用的插件

在main.js中通过app.use的函数来加载插件

import directions from './directions'
app.use(directions)