Vue TypeScript 开发怎么在 Vue 3 单文件组件中使用泛型声明 Props

老明姑娘_5760

老明姑娘_5760

2026-08-06

503人浏览

原创

vue 3 + typescript 中单文件组件的 props 泛型支持需通过 definecomponent 和 defineprops 显式泛型声明实现,推荐先定义泛型接口再传入 defineprops,配合 withdefaults 保持泛型完整性,并可提取为独立类型文件复用。

vue typescript 开发怎么在 vue 3 单文件组件中使用泛型声明 props

Vue 3 + TypeScript 中,单文件组件(SFC)的 Props 泛型支持需要借助 defineComponent 和 defineProps 的显式泛型声明方式实现。直接在 <script setup></script> 中用 defineProps<t>()</t> 是无效的——TypeScript 不允许泛型参数直接用于调用签名,必须通过类型参数推导或 as const + 类型断言等间接方式实现。

使用 defineProps 配合泛型接口(推荐)

最清晰、可维护的方式是先定义一个泛型接口,再将其传给 defineProps:

  • 在 <script setup lang="ts"></script> 中,声明一个带类型参数的接口,如 Props<t></t>
  • 用 defineProps<props>>()</props> 显式指定具体类型
  • 这样既保留类型安全,又支持子组件接收不同类型的 props(如 data: T[]、formatter: (v: T) => string)

示例:

Auth0 Vue
Auth0 Vue

在 Vue.js 3 中添加身份验证(登录、注销、用户会话、受保护路由),集成 @auth0/auth0-vue SDK,配合 Vite 使用。

下载
interface Props<t> {
  items: T[];
  keyName?: string;
  formatter?: (item: T) => string;
}
const props = defineProps<props>>();
</props></t>

利用 withDefaults 保持泛型完整性

如果泛型 Props 需要默认值,不能直接对泛型调用 withDefaults,而应先构造 props 类型,再包裹:

  • 先用 defineProps 获取泛型 props 类型(不带默认值)
  • 再用 withDefaults 传入相同泛型接口,并提供默认值对象
  • 确保默认值类型与泛型约束一致(例如 T 不能是 never 或未约束的 unknown)

示例:

interface ListProps<t> {
  data: T[];
  emptyText?: string;
}
const props = withDefaults(
  defineProps<listprops>>(),
  {
    emptyText: 'No data'
  }
);
</listprops></t>

避免常见错误:不要在 defineProps 调用中直接写泛型函数

以下写法 ❌ 会报错或失去类型推导:

  • defineProps<t>()</t> —— TypeScript 不允许泛型调用签名无上下文
  • defineProps() —— T 未声明,编译失败
  • 试图在 SFC 内部用 type Props<t> = ...</t> 然后 defineProps<props>>()</props> —— T 作用域不存在

正确做法是把泛型约束移到接口或类型别名定义处,并在实例化时填入具体类型。

进阶:组合式函数中复用泛型 Props 类型

当多个组件共享同一套泛型逻辑时,可将泛型 Props 提取为独立类型文件:

  • 新建 types/list-props.ts,导出 export type ListProps<t> = { data: T[]; ... }</t>
  • 各组件中直接导入并使用 defineProps<listprops>>()</listprops>
  • 配合 defineEmits() 可实现完整泛型事件契约

这样既提升复用性,也便于集中管理类型契约和文档注释。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vue.js vue typescript vue 3

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.08.11

2343

5

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

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

2023.10.09

5063

6

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

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

2024.03.19

6150

13

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

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

2024.03.22

5678

10

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

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

2024.05.22

803

5

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

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

2026.02.13

292

17

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

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

2026.02.25

500

17

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

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

2026.03.13

351

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

266

29

热门下载

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

精品课程

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

共42课时 | 17万人学习

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

共12课时 | 1.4万人学习

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

共18课时 | 1.7万人学习