UI 视觉设计 / 系统课时
建立组件命名规则
建立组件命名规则
本篇解决设计系统中组件名称混乱、设计稿与代码无法对应的问题。通过建立统一命名规则,让组件、属性、Variant、Token 和图层名称形成稳定映射,降低团队协作成本。
学习目标
- 理解组件命名需要解决的协作问题
- 掌握组件、属性、Variant 和 Token 的命名规则
- 能为设计文件和代码库建立一致的命名体系
为什么需要统一命名规则
组件命名不是简单的文字整理,而是设计系统的信息组织方式。如果同一个组件在设计稿中叫“按钮大号”,代码中叫 PrimaryButtonLarge,文档中又叫“主要操作按钮”,团队成员需要不断转换概念,维护成本会持续增加。
好的命名规则应该满足三个目标:看到名称即可理解用途、名称能够稳定映射到代码、随着组件增加仍然保持可扩展。
例如,按钮组件可以按照“组件类别 + 语义角色 + 状态”组织,而不是按照视觉细节命名。
组件与图层命名规范
组件名称应描述功能角色,而不是当前样式。颜色、尺寸、圆角等视觉属性属于 Token 或 Variant,不应该直接写进组件名称。
推荐规则:
| 类型 | 推荐命名 | 不推荐命名 |
|---|---|---|
| 组件 | Button | BlueButton |
| 组件状态 | Button/Disabled | ButtonGray |
| 输入组件 | Input/Text | InputBig |
| 导航组件 | Navigation/Menu | LeftMenuNew |
设计工具中的图层名称也应保持层级结构,例如:
text
Button
├── Label
├── Icon/Leading
└── Icon/Trailing这样开发人员查看设计稿时,可以快速理解组件内部结构。
Variant 和属性命名规则
Variant 用于表达组件的可变化维度,不应该把多个变化混在一个名称中。
例如,一个按钮可能有以下属性:
text
Button
├── Type: Primary | Secondary | Ghost
├── Size: Small | Medium | Large
└── State: Default | Hover | Disabled这种结构比创建大量独立组件更容易维护。
错误方式:
text
PrimaryLargeButtonDisabled问题在于名称同时包含多个维度,后续增加尺寸或状态时会快速膨胀。
Token 命名与设计开发映射
Token 命名应该体现用途,而不是具体数值。
例如:
json
{
"color.action.primary": "#2563EB",
"spacing.component.medium": "16px",
"radius.control.default": "8px"
}预期结果
text
color.action.primary → 主操作颜色
spacing.component.medium → 组件标准间距
radius.control.default → 默认控件圆角使用语义化 Token 后,设计调整主题时只需要修改 Token 值,而不需要逐个修改组件。
常见命名错误
组件命名中最常见的问题包括:
- 使用颜色、大小等视觉属性代替功能名称
- 一个名称同时表达多个状态和尺寸
- 设计文件名称与代码组件名称没有对应关系
- Token 使用具体数值导致无法复用
命名规则建立后,还需要通过文档和代码评审持续维护,否则系统会逐渐退化。
本课总结
- 组件名称应该表达功能角色,而不是当前视觉表现。
- Variant、属性和 Token 应拆分不同变化维度,避免名称膨胀。
- 统一命名体系能够降低设计与开发之间的转换成本。
下一课预告
下一课将介绍组件版本维护方法,学习如何处理新增、废弃、兼容和迁移,让设计系统持续演进。
按自己的节奏,确认真正理解。