核心命名公式
[模組前綴|類型|作用]_[名稱]_[狀態|位置]
- 全部小寫,單詞以
- 連接(kebab-case)
- 模組前綴:專案縮寫或功能域,如
blog-、shop-、admin-
- 類型:
layout、comp(元件)、util(工具類)
- 作用:
btn、input、list、card、modal
- 狀態/位置:
primary、disabled、hover、top、footer
常用詞彙縮寫表(團隊統一)
| 全拼 | 縮寫 | 全拼 | 縮寫 |
| button | btn | input | ipt |
| password | pwd | message/msg | msg |
| success | suc | error/err | err |
| warning | warn | info | info |
| container | ctn | wrapper | wrap |
| header | hd | footer | ft |
| sidebar | sd | navigation | nav |
| image | img | icon | ic |
| background | bg | border | bd |
| center | ctr | left/right | l/r |
實戰範例
/* 表單輸入框 */
.shop-comp-ipt-text /* 通用文字輸入 */
.shop-comp-ipt-pwd /* 密碼輸入 */
.shop-comp-ipt-pwd-login /* 登入頁密碼輸入 */
/* 提示訊息 */
.blog-util-msg-suc /* 成功提示 */
.blog-util-msg-err /* 錯誤提示 */
.blog-util-msg-warn /* 警告提示 */
/* 彈層 */
.admin-comp-modal /* 基礎彈層 */
.admin-comp-modal-confirm /* 確認彈層 */
.admin-comp-modal-pop-photo /* 相冊彈層 */
/* 顏色工具類 */
.u-c-tx-primary /* 主要文字色 */
.u-c-bg-secondary /* 次要背景色 */
.u-c-bd-focus /* 聚焦邊框色 */
/* 佈局工具類 */
.u-layout-ctr /* 水平置中 */
.u-layout-flex /* Flex 容器 */
自動化落地
- 建立
naming-convention.md 納入專案 README
- 配置
stylelint 規則強制 kebab-case、前綴檢查
- CI 階段跑
stylelint "**/*.css" 攔截不合規命名
- 元件庫 Storybook 中展示標準命名範例
避坑指南
- ❌ 顏色/尺寸直接寫類名:
.red、.w200 → 主題切換時失效
- ❌ 過度縮寫:
.btn-sbm → 改 .btn-submit 可讀性高
- ❌ 中文拼音:
.an-niu → 國際化團隊無法理解
- ✅ 語意化:
.btn-primary、.card__image--rounded