Vue 除了内置的一系列指令 (比如
v-model或v-show) 之外，Vue 还允许你注册自定义的指令。
一个自定义指令由一个包含类似组件生命周期钩子的对象来定义。钩子函数会接收到指令所绑定元素作为其参数。
在setup语法糖中，任何以 v 开头的驼峰式命名的变量都可以被用作一个自定义指令。
<script setup>
// 在模板中启用 v-focus
const vFocus = {
// 指令被绑定到元素上时调用
// el: 元素对象
// binding: 指令相关的信息
mounted: (el) => {
console.log(el);
// 可以在这里操作元素、添加事件监听等
el.style.color = "red";
el.addEventListener("click", () => {
console.log("Directive clicked");
});
},
};
</script>
<template>
<input v-focus />
</template>
效果展示：
没有使用setup
语法糖的情况下，自定义指令需要通过directives选项注册
<script>
export default {
setup() {
/*...*/
},
directives: {
// 在模板中启用 v-focus
focus: {
mounted: (el, binding) => {
console.log(el);
console.log(binding);
el.style.color = "red";
el.addEventListener("click", () => {
console.log("Directive clicked");
});
},
},
},
};
</script>也可以在全局进行绑定:
const app = Vue.createApp({});
app.directive('my-directive', {
mounted(el, binding) {
el.style.color = 'red';
el.addEventListener('click', () => {
console.log('Directive clicked');
});
},
});
app.mount('#app');
自定义指令的生命周期
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 钩子中可用。
