Skip to main content

Vue 自定义指令用法

一、自定义指令的定义​

Vue 除了 v-model、v-show 等内置指令外，还允许注册自定义指令 (Custom Directives)，用于复用 DOM 操作逻辑。

二、指令的注册及使用​

1、注册与使用​

在 <script setup> 中，任何以 v 开头的驼峰命名变量都可以被用作一个自定义指令。

举个例子：

用于自动聚焦的自定义指令
<template>
  <input v-focus />
</template>

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

该指令比 autofocus 属性更有用，不仅可以在页面加载完成后生效，还可以在 Vue 动态插入元素后生效。

Vue-JSX 自定义指令请参考 babel-plugin-transform-vue-jsx

除了局部注册，自定义指令也可以全局注册：

main.js
const app = createApp({})

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

2、指令钩子​

一个自定义指令由生命周期钩子对象来定义，可选的钩子函数如下：

const myDirective = {
  // 在元素的属性或事件监听器应用前调用
  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：指令绑定的元素；
  • 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 钩子中可用。

举个例子：

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

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

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

另外，和动态插槽名类似，自定义指令的参数也可以是动态的：

<div v-example:[arg]="value"></div>

3、指令全局注册​

自定义指令可以通过 app.directive 的方式进行全局注册：

全局注册：

main.js
import { createApp } from 'vue';
import App from './App.vue';

const app = createApp(App);

app.directive('focus', {
  mounted: (el) => el.focus(),
});

app.mount('#app');

使用：

App.vue
<template>
  <input v-focus />
</template>

4、简化形式的指令​

仅在 mounted 和 updated 上实现的行为，可以直接用一个函数来定义指令。

举个例子：

main.js
import { createApp } from 'vue';
import App from './App.vue';

const app = createApp(App);

app.directive('focus', {
  mounted: (el) => el.focus(),
});
app.directive('focus', (el) => {
  el.focus();
});

app.mount('#app');

5、给指令传递对象​

如果指令需要多个值，可以向它传递一个 JS 对象字面量。

举个例子：

main.js
app.directive('demo', (el, binding) => {
  console.log(binding.value.color) // => "white"
  console.log(binding.value.text) // => "hello!"
})

指令使用

App.vue
<div v-demo="{ color: 'white', text: 'hello!' }"></div>