Vue3 自定义指令详解——打造专属的 DOM 操作

前言

在 Vue 的世界里，指令是一种特殊的标记，可以附加到 DOM 元素上，使得当满足某些条件时，可以执行一些 JavaScript 代码。Vue 内置了很多指令，如 v-if、v-for 等，但有时候我们可能希望创建自己的自定义指令来满足特定的需求。Vue3 提供了一套简单而强大的 API 来创建自定义指令。本文将详细解析如何在 Vue3 中创建和使用自定义指令。

二、创建自定义指令

在 Vue3 中，自定义指令是通过 app.directive() 方法定义的。这个方法接受两个参数：指令的名称和一个包含指令钩子的对象。

import { createApp } from 'vue';  
  
const app = createApp({});  
  
// 定义一个自定义指令 v-focus  
app.directive('focus', {  
  // 当被绑定的元素挂载到 DOM 中时  
  mounted(el) {  
    // 聚焦元素  
    el.focus();  
  }  
});  
  
app.mount('#app');

上面的代码创建了一个名为 v-focus 的自定义指令。当使用这个指令的元素被挂载到 DOM 时，它会自动获取焦点。

三、指令钩子函数

自定义指令可以定义多个钩子函数，这些钩子函数在指令的不同生命周期被调用。Vue3 提供了以下几个钩子函数：

created：在绑定元素的父组件以及它自己的所有子节点都挂载完成后调用（父组件先于子组件挂载）。
beforeMount：在元素被插入到 DOM 前调用。
mounted：在元素被插入到 DOM 后调用。
beforeUpdate：在包含组件的 VNode 更新之前调用。
updated：在包含组件的 VNode 及其子 VNode 更新后调用。
beforeUnmount：在卸载包含组件的 VNode 之前调用。
unmounted：在卸载包含组件的 VNode 后调用。

需要注意的是，Vue3 中已经不再支持 bind 和 unbind 钩子，取而代之的是 mounted 和 unmounted。

四、使用自定义指令

定义好自定义指令后，就可以在模板中使用它了。使用自定义指令的语法和内置指令一样，都是以 v- 开头，后面跟着指令的名称。

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

上面的代码会在输入框被挂载到 DOM 后自动聚焦。

五、自定义指令的参数

自定义指令还可以接受参数，这些参数可以通过绑定值的语法传递给指令。参数可以在指令的钩子函数中以不同的方式使用。

app.directive('highlight', {  
  beforeMount(el, binding) {  
    el.style.backgroundColor = binding.value;  
  }  
});

<template>  
  <p v-highlight="'yellow'">这段文字会被高亮显示。</p>  
</template>

在这个例子中，我们创建了一个名为 v-highlight 的自定义指令，它接受一个参数作为背景颜色。当使用这个指令的元素被挂载到 DOM 前，它的背景颜色会被设置为传递进来的参数值。

六、总结

Vue3 的自定义指令提供了一种灵活而强大的方式来扩展 Vue 的功能。通过定义自己的指令，我们可以封装复杂的 DOM 操作和逻辑，使得在模板中使用它们变得更加简单和直观。希望本文能够帮助你理解 Vue3 中自定义指令的工作原理，并在实际项目中灵活运用它们。

原文链接：https://juejin.cn/post/7334644120353980425 作者：戛然而止ro