命名是前端工作中最容易被低估的成本。同一個語意,有人寫 .btn、有人寫 .button、還有人寫 .redClickableThing,團隊協作時這些差異會不斷累積成維護負債。以下整理一份參考自國內外大型網站的常用 ClassName 清單,共 100 餘個,做為專案命名規則的起點。
wrap、wrapper、container、header、footer、main、section、aside、sidebar、column、row、grid、module、group、clearfix、banner、bar、card
article、entry、content、title、subtitle、caption、description、summary、details、text、figure、thumbnail、gallery、audio、video、icon、avatar、chart、table、tab、slide、meta、time、copyright
action、button、submit、reset、close、show、hide、more、fewer、next、previous、first、last、sort、filter、search、share、save、preview、output、pagination、popup、tips、progress
field、label、input、select、checkbox、radio、disabled、selected、current、default、error、success、fail、msg、message、required
about、account、login、logout、signin、signup、register、subscribe、avatar、profile、setting、help、recommendations、promotion、feature、category、tag
active、hover、focus、checked、open、collapsed、loading、hidden、visible、highlight、primary、secondary、odd、even、on、off、large、small、full、pull-left、pull-right、text-center、muted、divider、spacer
第一,用連字符統一單字分隔。sidebar-nav 與 sidebarNav 不要在同一個專案並存,選一個貫穿到底。
第二,避免用樣式描述取代語意描述。.red、.bold14、.mt20 這類命名在改版時會立刻變成謊言;改成 .alert-danger、.text-emphasis、.section-spacing 才能活得長久。
第三,狀態類名統一前綴。建議用 is- 或 has- 開頭(如 is-active、is-disabled、has-error),一眼就能與版型類名區分。
第四,元件名加上語意後綴。-list、-item、-header、-body、-footer、-title 這組後綴能讓 BEM 式的命名自然成形,例如 comment-list / comment-item / comment-meta。