在 Vue3 中,自定义事件是组件间通信的重要机制,尤其适用于子组件向父组件传递数据的场景。以下是关键点的分步解释:
一、核心概念
-
与原生事件的区别
- 原生事件:浏览器原生事件(如
click
,input
)直接绑定到 DOM 元素。 - 自定义事件:由开发者通过
$emit
手动触发,用于组件间通信。
- 原生事件:浏览器原生事件(如
-
作用
子组件通过触发自定义事件,通知父组件执行特定操作或传递数据,实现解耦。
二、基本用法
1. 子组件触发事件
使用 $emit
方法触发事件,可传递任意数据:
<!-- ChildComponent.vue -->
<template>
<button @click="sendMessage">传递消息</button>
</template>
<script setup>
// Composition API 写法
const emit = defineEmits(['message-sent']);
const sendMessage = () => {
emit('message-sent', { text: 'Hello from child!' });
};
</script>
2. 父组件监听事件
通过 v-on
或 @
语法监听子组件事件:
<!-- ParentComponent.vue -->
<template>
<ChildComponent @message-sent="handleMessage" />
</template>
<script setup>
import ChildComponent from './ChildComponent.vue';
const handleMessage = (payload) => {
console.log(payload.text); // 输出:Hello from child!
};
</script>
三、高级特性
1. 显式声明事件(推荐)
通过 defineEmits
(Composition API)或 emits
选项(Options API)声明事件,提升代码可读性和维护性:
// Options API 写法
export default {
emits: ['message-sent'], // 显式声明
methods: {
sendMessage() {
this.$emit('message-sent', { text: '...' });
}
}
}
2. 事件验证
添加验证函数确保事件参数合法:
defineEmits({
'message-sent': (payload) => {
return payload.text && typeof payload.text === 'string';
}
});
四、注意事项
-
命名规范
推荐使用 kebab-case(如update-data
),避免与原生事件冲突。 -
.native
修饰符移除
Vue3 移除了.native
,监听原生事件需子组件显式继承:<!-- 子组件模板 --> <input v-bind="$attrs" />
-
与
v-model
的关联
自定义事件可用于实现自定义v-model
:// 子组件 defineEmits(['update:modelValue']); emit('update:modelValue', newValue);
五、常见问题
-
事件未触发
检查事件名是否一致(注意大小写)、是否已正确声明emits
。 -
类型提示
在 TypeScript 中,可通过泛型定义事件类型:const emit = defineEmits<{ (e: 'message-sent', payload: { text: string }): void; }>();
六、总结
Vue3 自定义事件通过 $emit
触发、@event
监听,结合 defineEmits
显式声明,提供了清晰的组件通信机制。通过事件校验和类型约束,能有效提升代码健壮性,是组件解耦的理想选择。