在Vue 2和Vue 3中,自定义指令可以通过全局注册和局部注册来创建。
一. 钩子函数比较
1.Vue2钩子函数
bind:只调用一次,指令第一次绑定到元素时调用
inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。
update:所在组件的 VNode 更新时调用
componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
unbind:只调用一次,指令与元素解绑时调用。
1.1钩子函数参数
- el:指令所绑定的元素 binding:一个对象
- binding:一个对象
- name:指令名,不包括 v- 前缀。
- value:指令的绑定值,例如:v-my-directive="1 + 1" 中,绑定值为 2。
- oldValue:指令绑定的前一个值,仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
- expression:字符串形式的指令表达式。例如 v-my-directive="1 + 1" 中,表达式为 "1 + 1"。
- arg:传给指令的参数,可选。例如 v-my-directive:foo 中,参数为 "foo"。
- modifiers:一个包含修饰符的对象。例如:v-my-directive.foo.bar 中,修饰符对象为 { foo: true, bar: true }。
- vnode:Vue 编译生成的虚拟节点。
- oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用
// 全局注册
Vue.directive('my-directive', {
bind(el, binding, vnode, oldVnode) {
// 指令绑定到元素上时调用
},
inserted(el, binding, vnode, oldVnode) {
// 被绑定元素插入父节点时调用
},
update(el, binding, vnode, oldVnode) {
// 被绑定于元素所在的模板更新时调用
},
componentUpdated(el, binding, vnode, oldVnode) {
// 被绑定元素所在模板完成一次更新周期时调用
},
unbind(el, binding, vnode, oldVnode) {
// 指令与元素解绑时调用
}
});
// 局部注册
new Vue({
el: '#app',
directives: {
'my-directive': {
bind(el, binding, vnode, oldVnode) {
// 指令逻辑
}
// ... 其他钩子函数
}
}
});
2.Vue3钩子函数
- beforeMount : 指令挂载到元素之前调用
- mounted: 挂载到元素上后调用
- beforeUpdate: 更新之前调用
- updated: 在绑定元素的父组件及他自己的所有子节点都更新后调用
- beforeUnmount: 元素被卸载之前调用
- unmounted: 元素被卸载之后调用
- vue3全局注册通过app.directive来绑定
省流: 自定义指令里的钩子函数和 Vue3的钩子函数保持一致
2.1钩子函数参数
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:使用该指令的组件实例。
vnode:代表绑定元素的底层 VNode。
prevVnode:代表之前的渲染中指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用
// 全局注册
const app = Vue.createApp({});
app.directive('my-directive', {
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) {
// 指令与元素解绑后调用
}
});
app.mount('#app');
// 局部注册
const app = Vue.createApp({
directives: {
'my-directive': {
beforeMount(el, binding, vnode) {
// 指令逻辑
},
// ... 其他钩子函数
}
}
});
app.mount('#app');
二. 案例举例
需求: 打开某个窗口时, 聚焦输入框input
注意点:
- 定义的时候不需要写v-, 使用时需要带上
- Vue 3 支持多根节点组件, Vue 2仅支持一个根节点
- 日常项目开发中, 一般于根目录下新建directive文件夹,在文件夹定义所需的自定义指令, 再将directive文件夹内容引入项目入口文件(main.js), 定义完毕, 在模板上使用直接v-xxx即可
vue2项目写法
注册全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
注册局部指令
directives: {
focus: {
// 指令的定义
inserted: function (el) {
el.focus()
}
}
}
在模板上使用 v-focus
<input v-focus>
vue3项目写法
注册局部指令
<script setup>
// 在模板中启用 v-focus
const vFocus = {
mounted: (el) => el.focus()
}
</script>
注册全局自定义指令 `v-focus`
const app = createApp({})
// 使 v-focus 在所有组件中都可用
app.directive('focus', {
/* ... */
})
在模板上使用 v-focus
<template>
<input v-focus />
</template>