CSS 模塊組織指南

任何超過 1000 行的 CSS 代碼,你都曾經(jīng)歷過這樣的體驗(yàn):

  1. 這個(gè) class 到底是什么意思呢湿滓?
  2. 這個(gè) class 在哪里被使用呢滴须?
  3. 如果我創(chuàng)建一個(gè) xxoo class,會(huì)造成沖突嗎叽奥?

Reasonable System for CSS Stylesheet Structure 的目標(biāo)就是解決以上問題扔水,它不是一個(gè)框架,而是通過規(guī)范朝氓,讓你構(gòu)建更健壯和可維護(hù)的 CSS 代碼魔市。

Components(組件)

Components
Components

Components 的角度思考,將網(wǎng)站的模塊都作為一個(gè)獨(dú)立的 Components赵哲。

Naming components (組件命名)

Components 最少以兩個(gè)單詞命名待德,通過 - 分離,例如:

  • 點(diǎn)贊按鈕 (.like-button)
  • 搜索框 (.search-form)
  • 文章卡片 (.article-card)

Elements (元素)

Elements
Elements

ElementsComponents 中的元素

Naming elements (元素命名)

Elements 的類名應(yīng)盡可能僅有一個(gè)單詞枫夺。

 .search-form {
    > .field { /* ... */ }
    > .action { /* ... */ }
  }
On multiple words (多個(gè)單詞)

對(duì)于倘若需要兩個(gè)或以上單詞表達(dá)的 Elements 類名将宪,不應(yīng)使用中劃線和下劃線連接,應(yīng)直接連接

  .profile-box {
    > .firstname { /* ... */ }
    > .lastname { /* ... */ }
    > .avatar { /* ... */ }
  }
Avoid tag selectors (避免標(biāo)簽選擇器)

任何時(shí)候盡可能使用 classnames涧偷。標(biāo)簽選擇器在使用上沒有問題簸喂,但是其性能上稍弱,并且表意不明確燎潮。

  .article-card {
    > h3    { /* ? avoid */ }
    > .name { /* ? better */ }
  }

Variants (變體)

Variants
Variants

ComponentsElements 可能都會(huì)擁有 Variants喻鳄。

Naming variants (變體命名)

Variantsclassname 應(yīng)帶有前綴中劃線 -

  .like-button {
    &.-wide { /* ... */ }
    &.-short { /* ... */ }
    &.-disabled { /* ... */ }
  }
Element variants (元素變體)
  .shopping-card {
    > .title { /* ... */ }
    > .title.-small { /* ... */ }
  }
Dash prefixes (中劃線前綴)

為什么使用中劃線作為變體的前綴?

  • 它可以避免歧義與 Elements
  • CSS class 僅能以單詞和 _- 開頭
  • 中劃線比下劃線更容易輸出

Layout (布局)

Layout
Layout
Avoid positioning properties (避免定位屬性)

Components 應(yīng)該在不同的上下文中都可以復(fù)用确封,所以應(yīng)避免設(shè)置以下屬性:

  • Positioning (position, top, left, right, bottom)
  • Floats (float, clear)
  • Margins (margin)
  • Dimensions (width, height) *
Fixed dimensions (固定尺寸)

頭像和 logos 這些元素應(yīng)該設(shè)置固定尺寸(寬度除呵,高度...)。

Define positioning in parents (在父元素中設(shè)置定位)

倘若你需要為組件設(shè)置定位爪喘,應(yīng)將在組件的上下文(父元素)中進(jìn)行處理颜曾,比如以下例子中,將 widthsfloats 應(yīng)用在 list component(.article-list) 當(dāng)中秉剑,而不是 component(.article-card) 自身泛豪。

  .article-list {
    & {
      @include clearfix;
    }

    > .article-card {
      width: 33.3%;
      float: left;
    }
  }

  .article-card {
    & { /* ... */ }
    > .image { /* ... */ }
    > .title { /* ... */ }
    > .category { /* ... */ }
  }

Avoid over-nesting (避免過分嵌套)

當(dāng)出現(xiàn)多個(gè)嵌套的時(shí)候容易失去控制,應(yīng)保持不超過一個(gè)嵌套侦鹏。

  /* ? Avoid: 3 levels of nesting */
  .image-frame {
    > .description {
      /* ... */

      > .icon {
        /* ... */
      }
    }
  }

  /* ? Better: 2 levels */
  .image-frame {
    > .description { /* ... */ }
    > .description > .icon { /* ... */ }
  }

Apprehensions (顧慮)

  • 中劃線-是一坨糟糕的玩意:其實(shí)你可以選擇性的使用诡曙,只要將 Components, Elements, Variants 記在心上即可。
  • 我有時(shí)候想不出兩個(gè)單詞唉:有些組件的確使用一個(gè)單詞就能表意略水,比如 aleter 价卤。但其實(shí)你可以使用后綴,使其意識(shí)更加明確渊涝。

比如塊級(jí)元素:

  • .alert-box
  • .alert-card
  • .alert-block

或行內(nèi)級(jí)元素

  • .link-button
  • .link-span

Terminologies (術(shù)語)

RSCSS 與其他 CSS 模塊組織系統(tǒng)相似的概念

RSCSS BEM SMACSS
Component Block Module
Element Element ?
Layout ? Layout
Variant Modifier Theme & State

Summary (總結(jié))

  • Components 的角度思考慎璧,以兩個(gè)單詞命名(.screenshot-image
  • Components 中的 Elements,以一個(gè)單詞命名(.blog-post .title
  • Variants跨释,以中劃線-作為前綴(.shop-banner.-with-icon
  • Components 可以互相嵌套
  • 記住胸私,你可以通過繼承讓事情變得更簡(jiǎn)單

譯自:Reasonable System for CSS Stylesheet Structure

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市鳖谈,隨后出現(xiàn)的幾起案子盖文,更是在濱河造成了極大的恐慌,老刑警劉巖蚯姆,帶你破解...
    沈念sama閱讀 206,378評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件五续,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡龄恋,警方通過查閱死者的電腦和手機(jī)疙驾,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,356評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來郭毕,“玉大人它碎,你說我怎么就攤上這事。” “怎么了扳肛?”我有些...
    開封第一講書人閱讀 152,702評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵傻挂,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我挖息,道長(zhǎng)金拒,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,259評(píng)論 1 279
  • 正文 為了忘掉前任套腹,我火速辦了婚禮绪抛,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘电禀。我一直安慰自己幢码,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,263評(píng)論 5 371
  • 文/花漫 我一把揭開白布尖飞。 她就那樣靜靜地躺著症副,像睡著了一般。 火紅的嫁衣襯著肌膚如雪政基。 梳的紋絲不亂的頭發(fā)上瓦糕,一...
    開封第一講書人閱讀 49,036評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音腋么,去河邊找鬼。 笑死亥揖,一個(gè)胖子當(dāng)著我的面吹牛珊擂,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播费变,決...
    沈念sama閱讀 38,349評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼摧扇,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了挚歧?” 一聲冷哼從身側(cè)響起扛稽,我...
    開封第一講書人閱讀 36,979評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎滑负,沒想到半個(gè)月后在张,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,469評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡矮慕,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,938評(píng)論 2 323
  • 正文 我和宋清朗相戀三年帮匾,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片痴鳄。...
    茶點(diǎn)故事閱讀 38,059評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡瘟斜,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情螺句,我是刑警寧澤虽惭,帶...
    沈念sama閱讀 33,703評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站蛇尚,受9級(jí)特大地震影響芽唇,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜佣蓉,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,257評(píng)論 3 307
  • 文/蒙蒙 一披摄、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧勇凭,春花似錦疚膊、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,262評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至璧函,卻和暖如春傀蚌,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蘸吓。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國(guó)打工善炫, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人库继。 一個(gè)月前我還...
    沈念sama閱讀 45,501評(píng)論 2 354
  • 正文 我出身青樓箩艺,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親宪萄。 傳聞我的和親對(duì)象是個(gè)殘疾皇子艺谆,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,792評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容

  • 此手冊(cè)主要實(shí)現(xiàn)的目標(biāo):代碼一致性和最佳實(shí)踐。通過代碼風(fēng)格的一致性拜英,降低維護(hù)代碼的成本以及改善多人協(xié)作的效率静汤。同時(shí)遵...
    _blow閱讀 369評(píng)論 0 0
  • 基本原則 結(jié)構(gòu)、樣式居凶、行為分離 統(tǒng)一縮進(jìn)(建議 兩個(gè)空格) 文件編碼統(tǒng)一 不帶BOM的UTF-8 一律使用小寫字母...
    KeKeMars閱讀 3,093評(píng)論 12 144
  • 本文主要是起筆記的作用虫给,內(nèi)容來自慕課網(wǎng). 認(rèn)識(shí)CSS樣式 CSS全稱為“層疊樣式表 (Cascading Styl...
    0o凍僵的企鵝o0閱讀 2,622評(píng)論 0 30
  • 1. Project guidelines 工程指南 1.1 Project structure 工程架構(gòu)New ...
    xiaobinZh閱讀 1,099評(píng)論 0 49
  • 這是一部關(guān)于工人詩(shī)人的電影,影片記錄了來自六個(gè)不同行業(yè)的工人侠碧,對(duì)于詩(shī)的熱愛和堅(jiān)持狰右。我們不妨從詩(shī)本身著手,從另一個(gè)角...
    梁光宇閱讀 1,752評(píng)論 20 29