vue 自定义指令 directive，指令封装

自定义指令 directive

介绍

自定义指令主要是为了重用涉及普通元素的底层 DOM 访问的逻辑。

全局

main.ts

import { createApp } from 'vue'

const app = createApp(App)
// v-focus 在所有组件中都可用
app.directive('focus', {
  mounted: (el) => el.focus()
})

模板

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

局部

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

模板

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

指令钩子

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) {}
}

指令的钩子会传递以下几种参数：

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

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

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

简写模式

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

统一利用插件封装优化

单个指令

src/directives/index.ts

import type { App } from 'vue'

export default {
  install(app: App<Element>) {
    app.directive('focus', {
      mounted: (el) => el.focus()
    })
  }
}

main.ts

import directives from '@/directives'

app.use(directives)

多个指令优化

src/directives/v-focus.ts

export const vFoucs = { mounted: (el: HTMLElement) => el.focus() }

src/directives/index.ts

import type { App, Directive } from 'vue'
import { vFoucs } from './v-focus'

const directivesList = {
  focus: vFoucs
}

export default {
  install(app: App<Element>) {
    Object.keys(directivesList).forEach((key) => {
      app.directive(key, (directivesList as { [key: string]: Directive })[key])
    })
  }
}