Vue3 mitt 史上最全使用指南,没有之一

一、安装 mitt

sql 复制代码
bashCopy Code
npm install mitt  # ‌:ml-citation{ref="1,2" data="citationList"}
pnpm install mitt # ‌:ml-citation{ref="2" data="citationList"}
yarn add mitt     # ‌:ml-citation{ref="3" data="citationList"}

二、基本使用方式

  1. ‌局部使用(单文件内) ‌

    • 创建事件总线实例:

      ruby 复制代码
      javascriptCopy Code
      import mitt from 'mitt';
      const emitter = mitt();  // ‌:ml-citation{ref="2,3" data="citationList"}
    • ‌触发事件‌:

      ruby 复制代码
      javascriptCopy Code
      emitter.emit('eventName', data);  // ‌:ml-citation{ref="1,2" data="citationList"}
    • ‌监听事件‌:

      ruby 复制代码
      javascriptCopy Code
      emitter.on('eventName', (data) => {
        console.log('接收数据:', data);
      });  // ‌:ml-citation{ref="1,2" data="citationList"}
  2. ‌全局使用(跨组件通信) ‌

    • 在 main.ts 中注册全局事件总线:

      ini 复制代码
      typescriptCopy Code
      import { createApp } from 'vue';
      import mitt from 'mitt';
      const app = createApp(App);
      app.config.globalProperties.emitter = mitt();  // ‌:ml-citation{ref="6,7" data="citationList"}
      app.mount('#app');
    • 在组件中通过全局属性调用:

      ruby 复制代码
      typescriptCopy Code
      import { getCurrentInstance } from 'vue';
      const { emitter } = getCurrentInstance()!.appContext.config.globalProperties;  // ‌:ml-citation{ref="2,7" data="citationList"}

三、事件监听与移除

操作 代码示例 作用说明
‌移除单个事件监听‌ emitter.off('eventName') 解绑指定事件‌
‌清空所有事件监听‌ emitter.all.clear() 移除所有监听‌
‌批量监听/移除‌ 结合 emitter.on 和 emitter.off 实现 动态管理事件‌

四、使用场景示例

  1. ‌组件间数据传递‌

    • 子组件触发事件:

      css 复制代码
      vueCopy Code
      <button @click="emitter.emit('send-data', { id: 1 })">发送数据</button>  // ‌:ml-citation{ref="5,8" data="citationList"}
    • 父组件监听事件:

      ruby 复制代码
      javascriptCopy Code
      emitter.on('send-data', (data) => {
        console.log('接收子组件数据:', data);
      });  // ‌:ml-citation{ref="5,8" data="citationList"}
  2. ‌跨层级组件通信‌

    • 非父子组件通过全局 emitter 实现交互,无需逐层传递 props‌。

五、注意事项

  1. ‌避免内存泄漏‌

    • 组件销毁时需手动移除事件监听(如在 onUnmounted 生命周期中调用 emitter.off)‌。
  2. ‌事件命名规范‌

    • 使用唯一且明确的事件名称,防止命名冲突‌。
  3. ‌TypeScript 支持‌

    • 全局使用时需扩展 ComponentCustomProperties 类型声明‌。

完整代码示例

typescript 复制代码
typescriptCopy Code
// 全局注册(main.ts)
import { createApp } from 'vue';
import mitt from 'mitt';
declare module '@vue/runtime-core' {
  interface ComponentCustomProperties {
    emitter: ReturnType<typeof mitt>;
  }
}
const app = createApp(App);
app.config.globalProperties.emitter = mitt();  // ‌:ml-citation{ref="7" data="citationList"}
app.mount('#app');

// 组件中使用
import { getCurrentInstance } from 'vue';
const { emitter } = getCurrentInstance()!.appContext.config.globalProperties;

// 触发事件
emitter.emit('update-list', { items: [1, 2, 3] });  // ‌:ml-citation{ref="1,2" data="citationList"}

// 监听事件
emitter.on('update-list', (data) => {
  console.log('列表更新:', data);
});  // ‌:ml-citation{ref="2,3" data="citationList"}

// 销毁时移除监听
onUnmounted(() => {
  emitter.off('update-list');  // ‌:ml-citation{ref="2,3" data="citationList"}
});
相关推荐
MyBili2 分钟前
Chrome开发者工具入门:从看懂页面到高效调试
前端·chrome·谷歌浏览器·开发工具·chrome devtools·网页调式·网络请求分析
云起SAAS12 分钟前
手机靓号选号商城H5源码 完整前后台可直接运行
前端·javascript·后端
程序员大阳20 分钟前
副队长Vue3教程(6)--script setup语法糖与ref基础响应式
vue.js·vue3·ref·script setup·基础响应式
code2cat24 分钟前
JavaScript编程篇之异步请求:切换到待办,为什么又显示了全部任务
前端·javascript
Moment1 小时前
RSI 是怎样让 AI 改进自己的 ❓❓❓
前端·后端·面试
1-1=01 小时前
Vue 条件渲染和列表渲染
前端·javascript·vue.js
前端双越老师1 小时前
程序员 1v1 访谈系列第十六期:裸辞后失业半年了
前端·ai编程·全栈
Highcharts.js1 小时前
Workbuddy + Highcharts Orbit:工作区数据自动建模与可视化分析实践
前端·javascript·信息可视化·数据可视化·highcharts·可视化图表·workbuddy
徐小夕1 小时前
MedDoc AI:把临床书写、协作、质控、知识问答装进一个工作台
前端·vue.js·github
艾莉丝努力练剑1 小时前
【QT】系统相关:TCP的API介绍
开发语言·前端·c++·人工智能·qt·学习·tcp/ip