在组件 <script setup> 中定义
<script setup>
// 在模板中启用 v-focus
const vFocus = {
mounted: (el) => el.focus()
}
</script>
<template>
<input v-focus />
</template>
在 <script setup> 中，任何以 v 开头的驼峰式命名的变量都可以被用作一个自定义指令。在上面的例子中，vFocus 即可以在模板中以 v-focus 的形式使用。
全局注册
const app = createApp({})
app.directive('focus',(el) => {
el.focus()
})
这时在所有的组件中都可以使用v-focus。
指令钩子
一个指令的定义对象可以提供几种钩子函数 (都是可选的)：
const myDirective = {
// 在绑定元素的 attribute 前
// 或事件监听器应用前调用
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) {}
}
app.directive('myDirective', myDirective)
钩子参数
指令的钩子会传递以下几种参数：
-
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钩子中可用。
举例来说，像下面这样使用指令：
<div v-example:foo.bar="baz">
// v-name:arg.modifiers=value
binding 参数会是一个这样的对象：
{
arg: 'foo',
modifiers: { bar: true },
value: /* `baz` 的值 */,
oldValue: /* 上一次更新时 `baz` 的值 */
}
简化形式
对于自定义指令来说，一个很常见的情况是仅仅需要在 mounted 和 updated 上实现相同的行为，除此之外并不需要其他钩子。这种情况下我们可以直接用一个函数来定义指令，如下所示：
<div v-color="color"></div>
app.directive('color', (el, binding) => {
// 这会在 mounted 和 updated 时都调用
el.style.color = binding.value
})
对象字面量
如果你的指令需要多个值，你可以向它传递一个 JavaScript 对象字面量。别忘了，指令也可以接收任何合法的 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!"
})
在组件上使用
当在组件上使用自定义指令时，它会始终应用于组件的根节点，和透传 attributes类似。
<MyComponent v-demo="test" />
<!-- MyComponent 的模板 -->
<div> <!-- v-demo 指令会被应用在此处 -->
<span>My component content</span>
</div>
需要注意的是组件可能含有多个根节点(Vue3的模板里支持多个根节点)。当应用到一个多根组件时，指令将会被忽略且抛出一个警告。和 attribute 不同，指令不能通过 v-bind="$attrs" 来传递给一个不同的元素。总的来说，不推荐在组件上使用自定义指令。
温馨提示：Vue3的模板里支持多个根节点，但是如果<router-view>嵌套在<transition></transition>组件中，最好还是在模板中使用一个根节点。否则会报
Component inside <Transition> renders non-element root node that cannot be animated.警告，并且会导致页面空白。
