活动组件的类名应该遵循哪些命名规则
活动组件的类名命名就像给工具箱贴标签
上周帮邻居老王收拾工具间,看着他那些缠作一团的电线插头,我突然想到这和程序员写活动组件类名的状况简直一模一样——你永远不知道"btn-01"和"button_new"到底哪个是紧急开关。今天就让我们像收拾工具箱那样,把活动组件的类名命名规则理个明明白白。
基础工具箱整理法则
就像不同尺寸的扳手要分格存放,好的类名应该让人扫一眼就知道用途:
- 工具实名制:用 activity-card__countdown 代替 ac-cd01,就像在工具箱贴"冲击钻专用电池"而非"黑盒子A"
- 家族式命名:event- 开头的类名就像把整套螺丝刀放在同一个抽屉,比如 event-register-btn
- 状态标签:给正在使用的工具挂红牌,比如 is-disabled 或 has-error
好例子 | 危险信号 | 数据来源 |
---|---|---|
campaign-modal__header | modalTop | W3C HTML规范 |
activity-tab--active | currentTab | BEM方法论 |
特殊工具的特殊对待
遇到多功能瑞士军刀式的组件时,我的经验是:
- 日期选择器就叫 date-picker,别搞什么 daySelectBox
- 带动画的加载图标用 loading-spinner--bounce 比 animate-load3 强十倍
常见车祸现场复原指南
上周实习生写的类名让我想起老王工具箱里的"那个玩意儿":
- 看见 newStyle2 就像找到把生锈的剪刀——永远不知道会不会划伤手
- leftBlock 这种命名,换个页面布局就得全盘重写
抢救方案实例
把 floatRight 改成 utility-align-right,就像给工具装上磁吸底座——既清楚用途又方便调整位置
问题类名 | 改造方案 | 改造依据 |
---|---|---|
bigRedButton | alert-button--critical | SMACSS架构 |
div5 | gallery-thumbnail | OOCSS原则 |
命名也要入乡随俗
就像电工箱和木工箱的标签写法不同:
- Vue项目里用 activity-form- 开头
- React组件库建议 CalendarEvent__ 格式
跨团队协作暗号
和隔壁组对接时发现他们用 evt- 前缀,就像发现邻居把老虎钳叫"大力夹",这时候需要个命名对照表:
业务模块 | 推荐前缀 | 备注 |
---|---|---|
营销活动 | campaign- | 参考Google Material Design |
用户互动 | interaction- | 遵循WAI-ARIA标准 |
我的命名急救包
工头老张的万能工具箱里永远备着这些:
- 在线校验工具:ClassName Linter
- VS Code插件:BEM Helper
- 命名灵感网站:UI Patterns Gallery
窗外的装修声渐渐停了,老王的工具间终于传出找到合适螺丝刀的欢呼声。或许明天上班时,我们写的类名也能让接手同事这般舒心呢。
评论
◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。
网友留言(0)