Vue 单文件组件怎么使用 withDefaults 设置默认值

秋芳同学_4906

秋芳同学_4906

2026-10-16

885人浏览

原创

withdefaults 仅用于 中配合 defineprops 设置 props 默认值,基础类型可直接赋值,引用类型须用函数返回以避免共享状态,不支持选项式 api 且不可用于 required prop。

vue 单文件组件怎么使用 withdefaults 设置默认值

在 Vue 单文件组件(SFC)中使用 withDefaults 设置 props 默认值,核心是配合 defineProps 在 <script setup></script> 里完成类型声明与默认值绑定。它只适用于组合式 API 的 setup 语法糖,不支持选项式 API。

基础写法:对象类型直接赋值

当 props 是基础类型(如 string、number、boolean)或简单对象时,可以直接用字面量设默认值:

  • message 没传时显示 'Hello, Vue 3!'
  • count 没传时取 0
  • 注意:可选属性需用 ? 标识,否则 TypeScript 会报错

<script setup lang="ts"><br>import { withDefaults, defineProps } from '<a style="color:#f60; text-decoration:underline;" title= "vue"href="https://m.php.cn/zt/15721.html" target="_blank">vue'<br><br>const props = withDefaults(<br> defineProps<{<br> message?: string<br> count?: number<br> } >(),<br> {<br> message: 'Hello, Vue 3!',<br> count: 0<br> }<br>)<br></script>

复杂类型:数组和对象必须用函数返回

对于引用类型(如 Array、Object、自定义接口),默认值必须包裹在函数中,避免多个组件实例共享同一份内存:

Vue Composition Analyzer
Vue Composition Analyzer

分析 Vue 3 Composition API 使用情况——审计响应式模式、可组合函数设计、ref 与 reactive 的选择、计算属性、watcher 使用及组件……

下载
  • 数组默认值写成 () => [] 或 () => [{ name: '张三', age: 18 }]
  • 对象默认值写成 () => ({ title: '默认标题', value: 0 })
  • 不这么做会导致响应式失效或状态污染

<script setup lang="ts"><br>interface User { name: string; age: number }<br><br>const props = withDefaults(<br> defineProps<{<br> users?: User[]<br> config?: { title: string; size: 'sm' | 'lg' }<br> } >(),<br> {<br> users: () => [],<br> config: () => ({ title: '未命名', size: 'sm' })<br> }<br>)<br></script>

和运行时声明的区别

不用 withDefaults 也能设默认值,比如这样写:

defineProps({
  message: { type: String, default: 'Hello' }
})

但这种方式属于运行时声明,需要额外引入 PropType、手动做类型断言,TS 类型推导弱。而 withDefaults 完全基于 TypeScript 接口,类型更准、代码更干净、IDE 支持更好。

注意事项

  • 只能在 <script setup></script> 中使用,普通 <script></script> 或选项式 API 不支持
  • 默认值仅在父组件未传递该 prop 时生效;传了 undefined 也会触发默认值
  • 不能用于 required: true 的 prop —— 既然必传,就不该设默认值
  • 不需要 import withDefaults 和 defineProps,它们是编译时宏,开箱即用

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

相关专题

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

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

2023.08.11

2503

5

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

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

2023.10.09

5383

6

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

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

2024.03.19

6430

13

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

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

2024.03.22

6018

10

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

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

2024.05.22

863

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

1674

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

12082

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

316

23

热门下载

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

精品课程

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

共42课时 | 17.1万人学习

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

共12课时 | 1.4万人学习

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

共18课时 | 1.7万人学习