專案多人協作時,統一的命名關鍵字能大幅降低溝通成本、避免衝突、提升代碼可讀性。以下整理業界通用的語意化命名對照表,建議納入團隊規範文件。
| 語意 | 推薦命名 | 備註 |
|---|---|---|
| 整體容器 | container, wrap, box | 最外層包裹,通常配合 max-width 置中 |
| 頁首 | header, hd | |
| 頁尾 | footer, ft | |
| 主內容區 | main, main-body, content | <main> 元素可直接用 |
| 側邊欄 | sidebar, side, aside | |
| 欄位/分欄 | col, column, col-1of3, col-2of3 | 網格系統專用 |
| 頁面區塊 | section, block, module |
| 語意 | 推薦命名 | 備註 |
|---|---|---|
| 主導航 | nav, main-nav, primary-nav | |
| 子導航 | sub-nav, secondary-nav | |
| 頂部導航 | top-nav, header-nav | |
| 麵包屑 | breadcrumb, crumb, current-path | |
| 分頁 | pagination, pager, page-nav | |
| 標籤頁 | tab, tab-nav, tab-list | |
| 選單/下拉 | menu, dropdown, dropmenu |
| 語意 | 推薦命名 | 備註 |
|---|---|---|
| Logo/品牌 | logo, brand, site-logo | |
| 大幅廣告/橫幅 | banner, hero, banner-img | |
| 搜尋區塊 | search, search-form | |
| 搜尋關鍵字輸入 | keyword, search-input, q | |
| 搜尋範圍/分類 | range, category, filter | |
| 標籤/標題 | tag, tag-title, tag-content, tag-current | |
| 標題區塊 | title, heading, hd | |
| 內容區塊 | content, cnt, body, entry | |
| 列表容器 | list, items, feed, stream | |
| 列表項目 | item, list-item, entry | |
| 卡片元件 | card, tile, panel | |
| 媒體物件 | media, media-object | 圖文混排經典模式 |
| 語意 | 推薦命名 | 備註 |
|---|---|---|
| 表單容器 | form, form-wrapper | |
| 輸入框群組 | form-group, field, input-group | |
| 標籤 | label, field-label | |
| 輸入控件 | input, field-input, control | |
| 提示/錯誤 | hint, help, error, message, feedback | |
| 按鈕 | btn, button, action | 修飾:btn-primary, btn-secondary, btn-lg |
| 圖示 | icon, ico | 修飾:icon-search, icon-user |
| 彈窗/模態框 | modal, dialog, popup, overlay | |
| 登入/註冊 | login, register, signup, signin |
| 語意 | 推薦命名 | 備註 |
|---|---|---|
| 當前/激活 | current, active, is-active, --active | |
| 禁用 | disabled, is-disabled, --disabled | |
| 載入中 | loading, is-loading, --loading | |
| 隱藏/顯示 | hidden, visible, is-hidden, --hidden | |
| 展開/摺疊 | expanded, collapsed, is-open, --open | |
| 選中/勾選 | selected, checked, is-selected | |
| 錯誤/警告/成功 | error, warning, success, is-error, --error | |
| 首個/最後 | first, last, --first, --last | |
| 奇數/偶數列 | odd, even, --odd, --even | 或用 :nth-child 偽類 |
.main-nav(非 .mainNav、.main_nav)。.btn-primary(主要動作)而非 .btn-blue;.sidebar 而非 .left-col。.block__element--modifier(雙底線元素、雙連字號修飾)。.btn 可,.b 不可;.nav-item 可,.ni 不可。.js- 或 data- 屬性,**絕不**在 CSS 中定義 .js-* 樣式。NAMING.md,Stylelint selector-class-pattern: "^[a-z][a-z0-9]*(-[a-z0-9]+)*(__[a-z0-9]+(-[a-z0-9]+)*)?(--[a-z0-9]+(-[a-z0-9]+)*)?$"。統一命名,是團隊協作效率的隱形乘數器。