自定义指令

介绍

除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外，Vue 还允许你注册自定义的指令 (Custom Directives)。

定义自定义指令

一个自定义指令由一个包含 类似组件生命周期钩子的对象 来定义。钩子函数会接收到指令所绑定元素作为其参数。

示例，当一个 input 元素被 Vue 插入到 DOM 中后，它会被自动聚焦：

组件注册

<!-- App.vue -->
<script setup>
// 在模板中启用 v-focus
const vFocus = {
  mounted: el => el.focus(),
}
</script>

全局注册

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

const app = createApp(App)

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

app.mount('#app')

钩子函数

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

钩子参数

• 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。

• prevVnode：代表之前的渲染中指令所绑定元素的 VNode。

  仅在 beforeUpdate 和 updated 钩子中可用。

提示

除了 el 外，其他参数都是只读的，不要更改它们。若你需要在不同的钩子间共享信息，推荐通过元素的 dataset attribute 实现。

简化形式

对于自定义指令来说，一个很常见的情况是仅仅需要在 mounted 和 updated 上实现相同的行为，除此之外并不需要其他钩子。这种情况下我们可以直接用一个函数来定义指令：

定义

app.directive('color', (el, binding) => {
  // 这会在 `mounted` 和 `updated` 时都调用
  el.style.color = binding.value
})

使用

<div v-color="color"></div>

传递对象字面量

别忘了，指令也可以接收任何合法的 JavaScript 表达式。

使用

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

定义

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

使用自定义指令

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

提示

只有当所需功能只能通过直接的 DOM 操作来实现时，才应该使用自定义指令。

建议尽可能使用 v-bind 等内置指令声明模板，因为它们更高效，对服务端渲染也更友好。

在组件上使用

注意

不推荐在组件上使用自定义指令。当组件具有多个根节点时可能会出现预期外的行为。

当在组件上使用自定义指令时，它会始终应用于组件的根节点，和透传 attributes 类似。

父组件

<MyComponent v-demo="test" />

MyComponent

<div> <!-- v-demo 指令会被应用在此处 -->
  <span>My component content</span>
</div>

需要注意的是组件可能含有多个根节点。当应用到一个多根组件时，指令将会被忽略且抛出一个警告。

和 attribute 不同，指令不能通过 v-bind="$attrs" 来传递给一个不同的元素。