在vue3.x中，注册局部自定义的指令是在
setup方法外面，directives下面便可自定义指令，那在vue3.2中的<script setup>标签该如何自定义指令呢？
先回顾全局自定义指令
vue2 全局自定义指令
在vue2中，全局自定义指令通过 directive 挂载到 Vue 对象上，使用Vue.directive('name',opt)。
Vue.directive('focus',{
inserted:(el)=>{
el.focus()
}
})
inserted 是钩子函数，在绑定元素插入父节点时执行。
vue3 全局自定义指令
在 vue3 中，vue 实例通过createApp 创建，所以全局自定义指令的挂载方式也改变了， directive 被挂载到 app上。
//全局自定义指令
app.directive('focus',{
mounted(el){
el.focus()
}
})
//组件使用
<input type="text" v-focus />
再回顾局部自定义指令
在组件内部，使用 directives 引入的叫做局部自定义指令。
<script>
//局部自定义指令
const defineDir = {
focus:{
mounted(el){
el.focus()
}
}
}
export default {
directives:defineDir,
setup(){}
}
</script>
其实，在vue3.2中，自定义指令变得更加的简单，直接上例子。
<template>
<input v-focus />
</template>
<script setup>
// 注册一个局部的自定义指令，需要以小写v开头
const vFocus = {
mounted(el) {
// 获取input，并调用其focus()方法
el.focus()
}
</script>
看到了吗，重点是：注册一个局部的自定义指令，需要以小写v开头。
这里做最简单示例，实战中举一反三灵活应用到项目中才是真理。
看完，你的项目需求可能会更复杂，所以系统掌握vue3中指令基础知识才是重点。
自定义指令中的生命周期钩子函数
一个指令定义对象可以提供如下几个钩子函数（都是可选的，根据需要引入）
- created ：绑定元素属性或事件监听器被应用之前调用。该指令需要附加需要在普通的 v-on 事件监听器前调用的事件监听器时，这很有用。
- beforeMounted ：当指令第一次绑定到元素并且在挂载父组件之前执行。
- mounted ：绑定元素的父组件被挂载之后调用。
- beforeUpdate ：在更新包含组件的 VNode 之前调用。
- updated ：在包含组件的 VNode 及其子组件的 VNode 更新后调用。
- beforeUnmounted ：在卸载绑定元素的父组件之前调用
- unmounted ：当指令与元素解除绑定且父组件已卸载时，只调用一次。
eg：测试指令内生命周期函数执行
<template>
<div>
<input type="text" v-focus v-if="show"><br>
<button @click="changStatus">{{show?'隐藏':'显示'}}</button>
</div>
</template>
//局部自定义指令
const autoFocus = {
focus:{
created(){
console.log('created');
},
beforeMount(){
console.log('beforeMount');
},
mounted(el){
console.log('mounted');
},
beforeUpdated(){
console.log('beforeUpdated')
},
updated(){
console.log('updated');
},
beforeUnmount(){
console.log('beforeUnmount');
},
unmounted(){
console.log('unmounted');
}
},
}
import { ref } from 'vue'
export default {
directives:autoFocus,
setup(){
const show = ref(true)
return {
show,
changStatus(){
show.value = !show.value
}
}
}
}
通过点击按钮，我们发现创建 input 元素的时候，会触发 created、beforeMount 和 mounted 三个钩子函数。
隐藏 input 元素的时候，会触发 beforeUnmount 和 unmounted 。
然而我们添加的 beforeUpdate 和 updated 函数并没有执行。
此时我们把 input 元素上的 v-if 修改成 v-show 就会执行上述两个方法了，具体的执行情况自行验证下。
从 vue2 升级到 vue3 ，自定义指令的生命周期钩子函数发生了改变，具体变化如下：
- bind 函数被替换成了beforeMounted。
- update 被移除。
- componentUpdated 被替换成了updated。
- unbind 被替换成了 unmounted。
- inserted 被移除。
自定义指令钩子函数的参数
钩子函数被赋予了以下参数：
- el：指令所绑定的元素，可以直接操作DOM。
- binding：是一个对象，包含该指令的所有信息。
binding 包含的属性具体的分别为：
- arg 自定义指令的参数名。
- value 自定义指令绑定的值。
- oldValue 指令绑定的前一个值。
- dir 被执行的钩子函数
- modifiers：一个包含修饰符的对象。
<template>
<div>
<div v-fixed >定位</div>
</div>
</template>
<script>
//自定义指令动态参数
const autoFocus = {
fixed:{
beforeMount(el,binding){
console.log('el',el)
console.log('binding',binding)
}
}
}
export default {
directives:autoFocus,
setup(){
}
}
</script>
自定义指令参数
自定义指令的也可以带参数，参数可以是动态的，参数可以根据组件实例数据进行实时更新。
eg：自定义指令动态参数
<template>
<div>
<div v-fixed:pos="posData" style="width:100px;height:100px;background:grey">定位</div>
</div>
</template>
<script>
//自定义指令动态参数
const autoFocus = {
fixed:{
beforeMount(el,binding){
el.style.position = "fixed"
el.style.left = binding.value.left+'px'
el.style.top = binding.value.top + 'px'
}
}
}
export default {
directives:autoFocus,
setup(){
const posData = {
left:20,
top:200
}
return {
posData,
}
}
}
</script>
什么时候需要自定义指令？
- 需要对普通 DOM 元素进行底层操作，这时候就会用到自定义指令。
- 需要将某些功能在指定DOM元素上使用，但对于需要操作大量DOM元素或者大变动时候，推荐使用组件，而不是指令。
参考资料：传送门
