vue3 自定义指令

Vue 除了内置的一系列指令 (比如 v-model 或 v-show) 之外,Vue 还允许你注册自定义的指令。

一个自定义指令由一个包含类似组件生命周期钩子的对象来定义。钩子函数会接收到指令所绑定元素作为其参数。

在setup语法糖中,任何以 v 开头的驼峰式命名的变量都可以被用作一个自定义指令。

javascript 复制代码
<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 选项注册

javascript 复制代码
<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>

也可以在全局进行绑定:

javascript 复制代码
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');

自定义指令的生命周期

javascript 复制代码
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) {}
}
javascript 复制代码
指令的钩子会传递以下几种参数:

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 钩子中可用。
相关推荐
程序员韩星24 分钟前
OpenAI 兼容接口返回 404,先查请求地址,再查模型名
前端·人工智能·http
Patrick_Wilson25 分钟前
构建通过了,为什么有些浏览器还会白屏?
前端·javascript·浏览器
其实防守也摸鱼1 小时前
用 Claude Code 重构遗留系统:从评估到落地的完整指南
前端·网络·人工智能·chrome·安全·重构
七仔啊1 小时前
CNC计算机数控加工模拟器
前端
张一凡932 小时前
你的 AGENTS.md,真的管到模型写代码了吗?
前端·后端·agent
Brookty2 小时前
CSS基础知识(一):选择器、优先级、层叠与继承、边框属性及盒模型
前端·css
颜进强2 小时前
微信小微AI-灰度与命中排查|代码全对、版本已发,为什么同事就是问不中?
前端·ai编程·全栈
verohh2 小时前
从代码组织到功能抽象:AI 时代的前端工程架构设计
前端
颜进强2 小时前
微信小微AI-评测|文档质量直接被判 0 分:小微团队评测那些没人告诉你的硬指标
前端·ai编程·全栈
Bacon2 小时前
给项目做一次"全身 CT":Agent Skills 生态里的代码体检全链路
前端·人工智能·后端