Vue3跨组件事件发射与监听:Header控制Sidebar展开的实现方案
Vue3平级组件通信适配方案(解决
$root.$on报错问题) 报错根因
- Vue3 正式移除了组件实例上挂载的
$on、$off、$once事件监听类API,原本依托根实例$root搭建全局事件总线的写法会直接抛出this.$root.$on is not a function错误 - 原有代码本身存在逻辑缺陷:
mounted钩子里给$on传的第二个参数不是可执行的回调函数,是直接执行this.sidebarOpen = true表达式得到的布尔值,就算在Vue2环境下运行,监听器也根本不会正常触发。
适配当前场景的落地实现
因为TheSidebar和TheHeader同属于Layout.vue的直接平级子组件,完全不需要引入额外事件总线类库,优先选择以下两种无冗余成本的方案:
方案1:状态提升至公共父组件(无额外依赖,最符合Vue设计规范)
把侧边栏的开关状态上移到Layout.vue中统一管理,通过props向下传递状态、通过自定义事件向上传递操作指令,遵循标准的单向数据流逻辑:
- Layout.vue 层定义公共状态
<script setup> import { ref } from 'vue' import TheHeader from './TheHeader.vue' import TheSidebar from './TheSidebar.vue' // 统一管理侧边栏开关状态 const sidebarOpen = ref(false) const toggleSidebar = () => { sidebarOpen.value = !sidebarOpen.value } </script> <template> <div class="layout-wrapper"> <!-- 监听Header触发的切换事件,更新全局状态 --> <TheHeader @toggle-sidebar="toggleSidebar" /> <!-- 把最新的状态值传给Sidebar控制展开/收起 --> <TheSidebar :is-open="sidebarOpen" /> </div> </template> - TheHeader 组件改造
移除原本的$root.$emit逻辑,通过组件自定义事件把点击操作抛给父组件<template> <header class="header"> <button @click="openSidebar">控制侧边栏</button> </header> </template> <script setup> // 声明要向父组件抛出的事件类型 const emit = defineEmits(['toggle-sidebar']) const openSidebar = () => { emit('toggle-sidebar') } </script> - TheSidebar 组件改造
移除原本的$root监听逻辑,直接接收父组件传入的状态值做展开控制<script setup> // 接收父组件传入的开关状态 defineProps({ isOpen: { type: Boolean, default: false } }) </script> <template> <aside class="sidebar" :class="{ 'sidebar--show': isOpen }"> 侧边栏菜单内容 </aside> </template>
方案2:Pinia 全局状态管理(适合项目已集成Pinia的场景)
如果项目已经使用Vue3官方推荐的Pinia做状态管理,可以把侧边栏状态抽离到独立的store中,两个组件直接读写store值,完全不需要做组件间的层级透传:
- 定义侧边栏专属store
// stores/sidebar.js import { ref } from 'vue' export const useSidebarStore = () => { const sidebarOpen = ref(false) const toggleSidebar = () => { sidebarOpen.value = !sidebarOpen.value } return { sidebarOpen, toggleSidebar } } - TheHeader中直接调用store的切换方法,TheSidebar中直接读取store的状态值即可,无需额外的事件通信逻辑。
注:如果后续遇到跨多层嵌套组件的通信需求,可以手动引入
mitt库创建独立的事件总线实例替代原有的$root事件逻辑,但针对当前Layout下两个直接平级子组件的场景,这类方案属于过度设计,会增加不必要的内存泄漏排查成本。
内容的提问来源于stack exchange,提问作者user15389576
相关产品推荐
相关产品推荐

