Vue3：自定义指令

一、快速上手

我们知道vue中有很多内置指令，例如v-model、v-bind等等。我们也可以自定义指令，提高代码复用率。以下是一个栗子：

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

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

上面的栗子中，自定义了一个输入框自动聚焦的指令。在setup 语法糖中，任何以 v 开头的驼峰式命名的变量都可以被用作一个自定义指令。在上面的例子中，vFocus 即可以在模板中以 v-focus 的形式使用。如果没有使用 setup 语法糖，需要在 directives 选项中声明：

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

全局注册自定义指令：

const app = createApp({})

// 使 v-focus 在所有组件中都可用
app.directive('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) {}
}

钩子函数中有以下几个参数：

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

举个栗子说明一下：

<script setup lang="ts">
import type { Directive } from 'vue';

// 在 <script setup> 中，任何以 v 开头的驼峰式命名的变量都可以被用作一个自定义指令
const vMyDirective = {
    mounted(el:HTMLInputElement, binding:any, vnode:any, prevVnode:any){
        console.log(binding);
        console.log(vnode);
        console.log(prevVnode);
        if(binding.modifiers.bar){
          el.value = binding.value.song + '坤坤'
        }
        el.focus()
    },
    updated(el:HTMLInputElement, binding:any){
      el.value += '鸡哥'
    }
}
let flag = ref(true)

</script>

<template>
  <div>
    <button @click="flag=!flag">点我召唤鸡哥</button>
  </div>
  自定义指令：<input type="text" v-myDirective:foo.bar="{song:'基尼太没', flag}" >
</template>

上面栗子中的binding是这样一个对象：

{
  arg: 'foo', // 参数
  modifiers: { bar: true }, // 修饰符
  value: {song: '基尼太没', flag: true}, // 绑定的值
  oldValue:  /* 上一次更新时 `baz` 的值 */
}

三、简写方式

自定义指令的简写方式：

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

使用自定义指令来实现按钮级权限控制：

<script setup lang="ts">
import type { Directive } from 'vue';

localStorage.setItem('userId', 'user')
// mock 后台返回的权限列表
const permission = [
  'user:goods:create',
  // 'user:goods:edit',
  'user:goods:delete'
]
// 使用自定义指令，实现按钮级权限控制 简写方式
const userId = localStorage.getItem('userId') as string
const vPermission:Directive<HTMLElement, string> = (el, binding) => {
  console.log(el);
  console.log(binding);
  if(!permission.includes(`${userId}:${binding.value}`)){
    el.style.display = 'none'
  }
}

</script>

<template>
  <div>
    <h3>自定义指令实现按钮级权限控制</h3>
    <button class="btn" v-permission="'goods:create'">创建</button>
    <button class="btn" v-permission="'goods:edit'">编辑</button>
    <button class="btn" v-permission="'goods:delete'">删除</button>
  </div>
</template>

<style scoped>
.btn{
  margin: 10px;
}
</style>