Vue 单文件组件怎么使用 TypeScript 定义 Props 类型

轻晨小哥_7402

轻晨小哥_7402

2026-11-04

708人浏览

原创

Vue SFC 中 TypeScript 定义 Props 的核心是 script setup + defineProps 宏,支持编译期检查与运行时校验;基础用接口或类型字面量,可选字段用?,默认值需 withDefaults,复杂类型须 PropType 显式标注。

vue 单文件组件怎么使用 typescript 定义 props 类型

在 Vue 单文件组件(SFC)中使用 TypeScript 定义 Props 类型,核心是配合 <script setup lang="ts"></script> 和 defineProps 宏。它能同时提供编译期类型检查和运行时校验,比纯 JavaScript 写法更安全、更智能。

基础写法:用接口或类型字面量声明

推荐直接在 defineProps 中传入一个 TypeScript 接口或对象类型字面量:

  • 接口定义更清晰,适合复用或复杂结构
  • 类型字面量适合简单、一次性 props

示例(接口方式):

<script setup lang="ts"><br> interface ProductProps {<br> &nbsp;&nbsp;id: number;<br> &nbsp;&nbsp;title: string;<br> &nbsp;&nbsp;price?: number;<br> &nbsp;&nbsp;inStock: boolean;<br> }<br> const props = defineProps<ProductProps>();<br> </script>

可选字段用 ? 标记,TypeScript 会自动识别是否必需。

带默认值的 Props 类型定义

当使用泛型方式(如 defineProps())时,不能直接在接口里写默认值。要用 withDefaults 包裹:

<script setup lang="ts"><br> interface ProductProps {<br> &nbsp;&nbsp;id: number;<br> &nbsp;&nbsp;title: string;<br> &nbsp;&nbsp;price?: number;<br> &nbsp;&nbsp;inStock: boolean;<br> }<br> const props = withDefaults(<br> &nbsp;&nbsp;defineProps<ProductProps>(),<br> &nbsp;&nbsp;{<br> &nbsp;&nbsp;&nbsp;&nbsp;price: 0,<br> &nbsp;&nbsp;&nbsp;&nbsp;inStock: true<br> &nbsp;&nbsp;}<br> );<br> </script>

withDefaults 不仅设了默认值,还保留完整的类型推导 —— 编辑器能提示哪些字段有默认值,哪些仍需父组件传入。

Element Plus UI Vue3
Element Plus UI Vue3

Element Plus Vue3 桌面组件库。在开发 Vue 3.x 页面时调用,使用 Element Plus 组件(如 el-button、el-input、el-form、el-table 等)。

下载

处理复杂类型(数组、对象、联合类型)

遇到嵌套结构或多种可能类型,建议用 PropType 显式标注:

  • 避免类型被擦除(比如 Array 默认推导为 any[])
  • 支持泛型数组、对象属性约束、联合字面量等精细控制

示例:

import { PropType } from 'vue'
<script setup lang="ts"><br> const props = defineProps({<br> &nbsp;&nbsp;tags: {<br> &nbsp;&nbsp;&nbsp;&nbsp;type: Array as PropType<string[]>,<br> &nbsp;&nbsp;&nbsp;&nbsp;default: () => []<br> &nbsp;&nbsp;},<br> &nbsp;&nbsp;status: {<br> &nbsp;&nbsp;&nbsp;&nbsp;type: String as PropType<'draft' | 'published' | 'archived'>,<br> &nbsp;&nbsp;&nbsp;&nbsp;required: true<br> &nbsp;&nbsp;},<br> &nbsp;&nbsp;meta: {<br> &nbsp;&nbsp;&nbsp;&nbsp;type: Object as PropType<{ author: string; publishedAt: Date }>,<br> &nbsp;&nbsp;&nbsp;&nbsp;default: () => ({ author: '', publishedAt: new Date() })<br> &nbsp;&nbsp;}<br> });<br> </script>

不使用 script setup 时的写法

如果组件没用 <script setup></script>,而是传统 Options API,需配合 defineComponent 和 props 选项:

<script lang="ts"><br> import { defineComponent } from 'vue';<br> export default defineComponent({<br> &nbsp;&nbsp;props: {<br> &nbsp;&nbsp;&nbsp;&nbsp;message: {<br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;type: String as const,<br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;required: true<br> &nbsp;&nbsp;&nbsp;&nbsp;}<br> &nbsp;&nbsp;},<br> &nbsp;&nbsp;setup(props) {<br> &nbsp;&nbsp;&nbsp;&nbsp;// props.message &#31867;&#22411;&#26159; string&#65292;&#19981;&#26159; any<br> &nbsp;&nbsp;&nbsp;&nbsp;return () => <div>{props.message};<br> &nbsp;&nbsp;}<br> });<br> </script>

此时 props 的类型由 Vue 自动从选项中推导,无需手动泛型,但必须用 defineComponent 包裹才能启用完整类型支持。

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

相关文章

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

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

下载

相关标签:

vue.js vue typescript

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

相关专题

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

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

2023.08.11

2823

5

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

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

2023.10.09

6123

6

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

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

2024.03.19

7070

13

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

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

2024.03.22

6878

10

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

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

2024.05.22

983

5

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

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

2026.02.13

312

17

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

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

2026.02.25

540

17

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

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

2026.03.13

391

19

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

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

2026.06.03

306

29

热门下载

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

精品课程

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

共42课时 | 17.4万人学习

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

共12课时 | 1.4万人学习

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

共18课时 | 1.7万人学习