自定义指令

介绍

Vue除内置的一些列指令外,还可以注册自定义指令

Vue中通过组件复用构建模块,通过组合式函数,复用有状态的逻辑,而自定义指令这是为了复用设计底层DOM的访问逻辑

一个自定义指令由一个包含类似组件生命周期钩子的对象过来定义.钩子函数会接受到指令所绑定的元素作为参数.下面是一个例子

<script setup>
  // 在模板中启用 v-highlight
  const vHighlight = {
    mounted: (el) => {
      el.classList.add('is-highlight')
    },
  }
</script>

<template>
  <p v-highlight>This sentence is important!</p>
</template>

在<script setup>中,任何以v开头的驼峰命名变量都可当做指令使用,不使用<script setup>的情况下,需要通过directives 选项刚注册

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

也可以在全局注册

const app = createApp({})

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

自定义指令的使用时机

只有当需求只能通过直接的DOM操作才能解决时,才需要自定义指令

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

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

该指令比 autofocus 属性更有用，因为它不仅在页面加载时有效，而且在 Vue 动态插入元素时也有效！

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

指令钩子

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"></div>

binding参数会使这样一个对象

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

和内置指令类似,指定以指令的参数也可以是动态的

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

简化形式

对于一个自定义指令来说,通常只需要在mounted和updated钩子中操作DOM,所以Vue提供了简写形式

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

对象字面量

如果指令需要多个值,可以传递一个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!"
})

在组件上使用

当在组件上使用自定义指令时,它始终会应用于组件的根节点上,但是需要注意,如果组件有多个根节点时,可能会出现无法预期的行为

<MyComponent v-demo="test" />

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