Props 属性默认值与 TS 怎么在 `` 中结合 withDefaults 完美实现默认值

秋涛君_1466

秋涛君_1466

2026-09-01

169人浏览

原创

withdefaults 是 vue 3 composition api 中为 defineprops 提供默认值的辅助函数,需与 typescript 类型声明分离使用:类型在 defineprops 中声明,默认值在 withdefaults 中指定,确保类型安全与运行时默认行为统一。

props 属性默认值与 ts 怎么在 `<script setup>` 中结合 withdefaults 完美实现默认值

在 Vue 3 的 Composition API 中,withDefaults 是专门为 defineProps 提供默认值而设计的辅助函数,它与 TypeScript 类型系统天然兼容,能同时保证类型安全和运行时默认行为。关键在于:TS 类型声明写在 defineProps 里,而默认值写在 withDefaults 里,二者分工明确、互不干扰。

✅ 正确写法:类型与默认值分离

不能把默认值直接写在 TS 类型中(比如 foo?: string),那只是表示“可选”,不是“默认为某值”。必须用 withDefaults 显式指定:

  • 先用 defineProps 声明完整类型(含必填/可选)
  • 再用 withDefaults 包裹它,并传入默认值对象
  • TS 会自动推导出最终 props 类型(含默认值后的非可选性)

示例:

const props = withDefaults(
  defineProps(),
  {
    count: 0,
    disabled: false
  }
)

此时 props.count 和 props.disabled 在 TS 中不再是可选类型,访问时无需非空断言或可选链。

⚠️ 常见错误:类型里写默认值 or 混用 default 选项

以下写法是错的或不推荐的:

Vuejs
Vuejs

Vue.js 官方推荐通过 npm 进行安装,这是构建现代化前端项目最主流的方式。在终端中执行 npm install vue 即可获取最新稳定版,如需指定版本可添加 @版本号,例如 npm install vue@3.4.0。安装前请确保已配置 Node.js 环境(推荐 v18 及以上版本),并建议将 npm 镜像源切换至国内镜像以提升下载速度。对于大型项目,还可通过 npm create v

下载
  • count?: number + withDefaults(..., { count: 0 }) ✅ 可以,但 ? 其实多余——withDefaults 已让字段变为必填语义
  • count: number = 0 ❌ TS 不允许在接口/类型字面量中写默认值
  • 用 defineProps({ count: { type: Number, default: 0 } }) ❌ 这是 Options API 风格,丢失 TS 类型精度,且无法做复杂类型推导(如泛型、联合类型)

? 处理函数、对象、数组等复杂默认值

默认值支持工厂函数,避免引用类型被共享:

  • 基本类型(string, number, boolean)可直接写字面量
  • 对象、数组、正则、日期等引用类型,必须用函数返回新实例
  • 函数类型默认值也建议用函数包裹,防止意外执行

示例:

const props = withDefaults(
  defineProps
    items: string[]
    onClick: () => void
  }>(),
  {
    config: () => ({}),
    items: () => [],
    onClick: () => {}
  }
)

? 小技巧:利用 TS 类型推导简化书写

如果默认值逻辑简单,可以先定义默认值对象,再让 TS 自动推导 props 类型:

const defaultProps = {
  count: 0,
  disabled: false,
  theme: 'light' as const
}

const props = withDefaults(
  defineProps<typeof defaultprops title: string>(),
  defaultProps
)</typeof>

这样既复用默认值,又保持类型精确(比如 theme 推导为字面量类型 'light' 而非 string)。

相关专题

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

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

2023.08.11

2103

5

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

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

2023.10.09

4503

6

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

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

2024.03.19

5650

13

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

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

2024.03.22

5098

10

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

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

2024.05.22

723

5

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

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

2026.02.13

252

17

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

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

2026.02.25

480

17

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

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

2026.03.13

311

19

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

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

2026.06.03

226

29

热门下载

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

精品课程

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

共42课时 | 16.7万人学习

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

共12课时 | 1.4万人学习

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

共18课时 | 1.6万人学习