Vue 组件 API 命名设计模式

梦明酱_6260

梦明酱_6260

2026-06-09

789人浏览

原创

vue组件api命名遵循可读性、一致性、类型安全和业务语义原则:props用camelcase并带业务上下文;事件用kebab-case且动词表意图;插槽语义化命名;组件名用pascalcase且多词防冲突。

vue 组件 api 命名设计模式

Vue 组件 API 的命名不是随意拼凑,而是围绕可读性、一致性、类型安全和业务语义构建的一套实践体系。核心目标是让使用者“看名知意、用得顺手、改得安心”。

Props 命名:统一用 camelCase,带业务上下文

所有 prop 名必须使用小驼峰(camelCase),避免中划线或大驼峰。这不是风格偏好,而是 Vue 编译器对 JavaScript 对象属性的天然支持——模板中写 v-bind:is-loading="true",实际接收的仍是 isLoading。

关键细节:

  • 不单用缩写,如用 showCloseButton 而非 showClose 或 closeBtn
  • 布尔类 prop 必须以 is、has、can、should 开头,例如 isDisabled、hasHeader
  • 枚举类 prop 需配合 validator,如 status 只接受 'idle' | 'loading' | 'success' | 'error'
  • 每个 prop 必须声明 type 和 default 或 required: true,TypeScript 接口需同步导出

事件命名:全小写 + 中划线,动词表意图

自定义事件名采用 kebab-case(小写+短横线),这是 Vue 官方推荐且 DOM 原生事件兼容的最佳实践。比如组件内部触发 update:modelValue,父组件监听时可写 @update:model-value,Vue 会自动转换为 onUpdateModelValue。

常见模式:

  • 状态变更类: update:model-value、change:tab-index
  • 用户交互类: click:outside、submit:form、select:item
  • 生命周期/流程类: open:drawer、cancel:edit

避免模糊动词如 done、ok;优先用 confirm、apply、discard 等明确表达动作意图的词。

check-vue-style
check-vue-style

检查 .vue 单文件组件的 CSS 规范问题并给出提示,适用于样式检查、CSS审查和 Vue 页面质量巡检。

下载

插槽命名:语义化 + 默认 slot 保留无名

具名插槽名同样使用 kebab-case,强调其内容角色而非技术实现。默认插槽保持匿名,不强制命名;有多个逻辑区域时,按内容职责命名:

  • header、footer、actions —— 通用布局区
  • empty-state、loading-indicator、error-message —— 状态反馈区
  • item-content、row-actions —— 列表/表格子项级插槽

不建议用 slot1、customSlot 这类无意义名称;也不推荐过度拆分,一个插槽能承载的结构尽量收敛。

组件自身命名:PascalCase,多词且可读

组件名本身也是 API 的一部分。必须使用 PascalCase,且至少两个单词,防止与原生 HTML 标签冲突(如 Button 易混淆,BaseButton 或 AppButton 更安全)。

命名逻辑分层清晰:

  • 基础组件:以 Base 或 Ui 开头,如 BaseInput、UiAvatar
  • 业务组件:体现领域,如 OrderSummaryCard、UserProfileForm
  • 页面组件:以 Page 结尾,如 DashboardPage、ProductListPage

组件注册时,在模板中也应使用 PascalCase 自闭合写法:<userprofileform></userprofileform>,而非 <user-profile-form></user-profile-form>。

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

相关文章

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

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

下载

相关标签:

vue

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

相关专题

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

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

2023.08.11

2303

5

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

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

2023.10.09

4963

6

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

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

2024.03.19

6050

13

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

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

2024.03.22

5558

10

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

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

2024.05.22

783

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

1634

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

11882

5

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

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

2026.02.10

296

23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app快速上手
uni-app快速上手

共0课时 | 0人学习

Vue 教程
Vue 教程

共42课时 | 17万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 2.5万人学习