Vue3 自定义指令

一、使用自定义指令

使用 v- 前缀来表示一个指令

<template>
  <div v-change-color="'red'">Hello, World!</div>
</template>

二、指令生命周期

• beforeMount：在绑定元素挂载到 DOM 之前调用。
• mounted：在绑定元素挂载到 DOM 之后调用。
• beforeUpdate：在组件更新之前调用。
• updated：在组件更新之后调用。
• beforeUnmount：在组件卸载之前调用。
• unmounted：在组件卸载之后调用。

钩子参数

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

三、全局注册自定义指令

新建 directives/index.ts 文件

import WaterMarkerfrom './WaterMarker.vue'
// 自定义指令
const directives = {
  WaterMarker,
  ...
}
 
export default {
  install(app) {
    Object.keys(directives).forEach((key) => {
      app.directive(key, directives[key])
    })
  },
}

在 main.ts 引入并调用

import directives from './directives/index.js'
const app = createApp({})

app.use(directives)

四、局部注册自定义指令

注意：必须是v 开头的驼峰式命名的变量才可以被用作一个自定义指令（在setup语法糖中）

<template>
  <input v-focus />
</template>

<script setup lang="ts">
import type { Directive, DirectiveBinding } from "vue";
const vFocus: Directive = {
  mounted(el: HTMLElement, binding: DirectiveBinding) {
    el.focus();
  },
};
</script>
<style scoped></style>

五、总结

自定义指令运用场景很多，在项目中运用好自定义指令能帮助我们更加高效实现功能。接下来我会介绍项目中常用水印指令、默认图片指令、滚动加载指令指令等，敬请期待！！！