在  <script setup>  中，任何以  v  开头的驼峰式命名的变量都可以被用作一个自定义指令。在上面的例子中， vFocus  即可以在模板中以  v-focus  的形式使用。

export default {
  setup() {
    /*...*/
  },
  directives: {
    // 在模板中启用 v-focus
    focus: {
      /* ... */
    }
  }
}


//全局注册

const app = createApp({})

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

当在组件上使用自定义指令时，它会始终应用于组件的根节点

指令钩子

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

举例来说，像下面这样使用指令：

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

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

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