Props 配合 Composition API 如何写类型声明?defineProps 实战

夜雪酱_5569

夜雪酱_5569

2026-05-01

546人浏览

原创

Vue 3 中 defineProps 类型声明有运行时和基于类型的两种方式,推荐使用泛型接口(如 defineProps);需深度校验时用 PropType 显式标注,二者不可混用。

props 配合 composition api 如何写类型声明?defineprops 实战

Vue 3 中配合 Composition API 使用 defineProps 做类型声明,核心就两条路:运行时声明(JS 风格)和基于类型的声明(TS 推荐)。后者更简洁、类型推导更强,也更符合现代 Vue + TypeScript 工程实践。

用泛型接口写 props 类型(最常用)

这是绝大多数项目首选方式。直接在 defineProps 中传入一个类型字面量或接口,TypeScript 编译器会自动推导出对应的运行时校验逻辑:

  • 基础写法(类型字面量):
    <script setup lang="ts"><br>const props = defineProps<{<br>  title: string<br>  count?: number<br>  disabled: boolean<br></script>
  • 拆出 interface(适合复用或复杂结构):
    <script setup lang="ts"><br>interface CardProps {<br>  id: number<br>  title: string<br>  tags?: string[]<br>  meta?: { author: string; date: string }<br>}<br>const props = defineProps<CardProps>()<br></script>

带默认值的类型声明(withDefaults)

纯类型声明本身不支持默认值,必须搭配 withDefaults —— 它会在编译期把第二个参数转为运行时的 default 选项,同时保持类型安全:

Manus
Manus

一款通用型AI智能体平台,可根据用户提出的目标自主拆解任务并执行多步骤工作,适合处理研究、分析和内容制作等复杂任务。

下载
  • <script setup lang="ts"><br>interface Props {<br>  msg: string<br>  title?: string<br>  list: { id: number; name: string }[]<br>}<br>const props = withDefaults(defineProps<Props>(), {<br>  title: '默认标题',<br>  list: () => []<br>})<br></script>
  • 注意:函数式默认值(如 () => [])必须是箭头函数,且不能是内联对象字面量(比如 {}),否则 TS 会报错。

需要深度类型校验?用 PropType

当 props 是自定义类、联合类型或需要精确控制构造函数/枚举等场景,就得借助 PropType 显式标注:

  • import { defineProps, PropType } from 'vue'<br>interface User { id: number; role: 'admin' | 'user' }<br>const props = defineProps({<br>  user: { type: Object as PropType<user>, required: true },<br>  status: { type: String as PropType, default: 'pending' }<br>})</user>
  • 这种写法保留了运行时校验能力(比如非 object 传入会警告),又让 IDE 和 TS 能精准识别内部字段类型。

别混用两种声明方式

运行时声明(对象传参)和基于类型的声明(泛型)不能共存于同一个 defineProps 调用中。选一种坚持到底:

  • ✅ 可以:defineProps() 或 defineProps({ a: String })
  • ❌ 不可以:defineProps({ a: String }) —— 编译报错

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

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

相关专题

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

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

2023.08.11

2763

5

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

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

2023.10.09

6023

6

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

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

2024.03.19

6970

13

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

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

2024.03.22

6738

10

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

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

2024.05.22

963

5

C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3569

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2428

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1360

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1318

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
零基础精通 PS 视频教程
零基础精通 PS 视频教程

共268课时 | 120.4万人学习

前端工程师必备技能—PS切图
前端工程师必备技能—PS切图

共11课时 | 2.2万人学习

麦子学院Photoshop切片视频教程
麦子学院Photoshop切片视频教程

共13课时 | 4.3万人学习