命名的核心原則
- 語意化:描述「是什麼」,而非「長什麼樣」(
.red-btn × → .btn-primary ✓)。
- 低耦合:不綁定標籤、位置、具體數值。
- 一致性:專案統一風格(kebab-case、BEM、前綴)。
- 可搜尋:避免過度縮寫(
.btn-pr × → .btn-primary ✓)。
常見區塊命名參考表
| 區塊 | 推薦命名 | 備註 |
| 頁首 | .header, .site-header | |
| 導航 | .nav, .main-nav, .sub-nav | |
| 側欄 | .sidebar, .aside | |
| 主內容 | .main, .content, .container | |
| 頁尾 | .footer, .site-footer | |
| Logo | .logo, .site-logo | |
| 橫幅/廣告 | .banner, .hero, .ad | |
| 搜尋 | .search, .search-form | |
| 登入/註冊 | .login, .register, .auth-form | |
| 文章/卡片 | .post, .article, .card | |
| 列表 | .list, .post-list | |
| 分頁 | .pagination, .pager | |
| 模態框 | .modal, .dialog, .overlay | |
| 按鈕 | .btn, .btn-primary | |
| 表單欄位 | .form-control, .input, .field | |
| 狀態修飾 | .is-active, .is-hidden, .has-error | is-/has- 前綴 |
BEM (Block Element Modifier) 方法論
.block { } /* 獨立區塊 */
.block__element { } /* 區塊內的元素(雙底線) */
.block--modifier { } /* 區塊的變體/狀態(雙連字號) */
.block__element--modifier { } /* 元素的變體 */
實例:卡片元件
.card { }
.card__image { }
.card__title { }
.card__description { }
.card__footer { }
.card--featured { } /* 整張卡片的變體 */
.card__title--large { } /* 標題的變體 */
HTML 結構
<article class="card card--featured">
<img class="card__image" src="..." alt="">
<div class="card__body">
<h2 class="card__title card__title--large">標題</h2>
<p class="card__description">摘要</p>
</div>
<footer class="card__footer">...</footer>
</article>
ID vs Class 使用原則
- ID:全頁唯一、錨點導航、JS 掛載點(
#main-content, #user-menu)。不可複用、不可用於樣式選擇器(權重過高、難覆蓋)。
- Class:可複用、樣式主力、可組合(
.btn .btn-primary .btn-lg)。
狀態類命名慣例
| 前綴 | 用途 | 範例 |
is- | JS 動態切換的狀態 | .is-open, .is-loading, .is-valid |
has- | 擁有某特徵/子元素 | .has-dropdown, .has-icon |
js- | 專供 JS 選取,不掛樣式 | .js-modal-trigger, .js-datepicker |
u- | Utility 實用類(單一用途) | .u-mt-4, .u-text-center |
團隊規約檢查清單
- [ ] 統一使用 kebab-case(
.my-component)。
- [ ] 禁止縮寫(
.nav 可、.nv 不可)。
- [ ] 禁止外觀描述(
.left-sidebar → .sidebar + 佈局類控制位置)。
- [ ] 元件根類名與資料夾/檔名對應(
Card.vue → .card)。
- [ ] 狀態類用
is-/has-,修飾類用 --。
- [ ] 定期用 Stylelint + custom rules 強制檢查。
總結
好的命名是給未來的自己與團隊留下的文檔。採用 BEM 提供結構化語意,配合 is-/has-/js-/u- 前綴區分關注點,嚴禁 ID 寫樣式、禁用外觀命名,並以工具鏈固化規約,才能在專案規模擴大時保持 CSS 架構清晰、低耦合、高復用。