讲师中心 微信公众号
AI工具推荐 视频效率加速

Vue 组件 Emits 怎么在 TypeScript 中声明事件类型

秋静酱_1810

秋静酱_1810

发布时间:2026-10-22 06:08:23

|

389人浏览过

|

来源于php中文网

原创

Vue组件emits的TypeScript类型声明核心是defineEmits泛型函数签名,支持事件名、参数个数与类型的精准推导和校验,确保IDE跳转、编译报错及重构联动;推荐<script setup>中使用泛型声明,如defineEmits<{(e:'submit',data:FormData):void;(e:'cancel'):void}>(),支持重载;也可用数组声明+const断言或扩展第三方库类型,父子组件事件参数类型自动对齐校验。

vue 组件 emits 怎么在 typescript 中声明事件类型

Vue 组件的 emits 在 TypeScript 中声明事件类型,核心是用 defineEmits 配合泛型函数签名,让事件名、参数个数和类型全部可推导、可校验。不是加个注释,而是让 IDE 能跳转、编译器能报错、重构时能联动更新。

用泛型声明精确的事件签名

这是最推荐的方式,尤其适合 <script setup> 场景。每个事件对应一个函数签名,参数顺序和类型都明确:

  • defineEmits<{ (e: 'submit', data: FormData): void; (e: 'cancel'): void }>() —— 表示组件可触发 submit(带一个 FormData 参数)或 cancel(无参)
  • 多个同名事件?可以重载:(e: 'change', value: string): void; (e: 'change', value: number): void
  • 返回的 emit 函数会严格校验调用:写 emit('submit', 123) 就直接报错,因为类型不匹配

运行时声明 + 类型断言(兼容简单场景)

如果暂时不想写泛型,或需动态判断事件合法性,可用数组形式声明事件名,再配合类型断言保障参数安全:

vue-composition-api-best-practices
vue-composition-api-best-practices

Vue 3 组合式 API 与 最佳实践,涵盖代码组织、useXxx 模式、组合式函数设计、Store 集成、响应式优化及功能抽取。

下载
  • const emit = defineEmits(['update:modelValue', 'error']) —— 声明允许触发的事件名
  • 手动标注调用类型:emit('update:modelValue' as const, newValue),避免字符串字面量被宽泛推导为 string
  • 适合快速原型或事件结构极简的组件,但失去参数级类型检查

对接第三方组件库(如 PrimeVue)

官方类型往往只覆盖基础事件,复杂交互需要自己补全。以 Button 为例:

立即学习“前端免费学习笔记(深入)”;

  • 通过模块声明扩展:declare module 'primevue/button' { interface ButtonEmits { (e: 'click', ev: MouseEvent, el: HTMLButtonElement): void } }
  • 或用工具类型简化:import { ComponentEmits } from 'primevue/src/utils/type-utils'; type ButtonEmits = ComponentEmits<{ click: [MouseEvent, HTMLButtonElement] }>
  • 补全后,父组件监听 @click 时就能获得准确的 ev 和 el 类型提示

注意父子组件类型一致性

子组件声明了 emits 类型,父组件使用时也要对齐:

  • 绑定事件时,@update:modelValue="onUpdate" 的 onUpdate 函数参数类型会自动推导为子组件定义的 value 类型
  • 若子组件用 defineEmits<{ (e: 'change', id: number): void }>(),父组件里写 @change="handler",则 handler 的第一个参数就是 number
  • 不一致会触发 TS 错误,比如把 id: number 传成 string,编译阶段就拦住

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2583

2023.08.11

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

5583

2023.10.09

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

6590

2024.03.19

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

6258

2024.03.22

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

883

2024.05.22

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

292

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

520

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

371

2026.03.13

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17.2万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn