CSS Modules 用法教程

作者:阮一峰
原文地址:http://www.ruanyifeng.com/blog/2016/06/css_modules.html

學過網頁開發就會知道,CSS 不能算編程語言,只是網頁樣式的一種描述方法。

為了讓 CSS 也能適用軟件工程方法,程序員想了各種辦法,讓它變得像一門編程語言。從最早的Less、SASS,到后來的 PostCSS,再到最近的 CSS in JS,都是為了解決這個問題。

本文介紹的 CSS Modules 有所不同。它不是將 CSS 改造成編程語言,而是功能很單純,只加入了局部作用域和模塊依賴,這恰恰是網頁組件最急需的功能。

因此,CSS Modules 很容易學,因為它的規則少,同時又非常有用,可以保證某個組件的樣式,不會影響到其他組件。

零、示例庫

我為這個教程寫了一個示例庫,包含六個Demo。通過它們,你可以輕松學會CSS Modules。

首先,克隆示例庫。

$ git clone https://github.com/ruanyf/css-modules-demos.git

然后,安裝依賴。

$ cd css-modules-demos
$ npm install

接著,就可以運行第一個示例了。

$ npm run demo01

打開瀏覽器,訪問http://localhost:8080,查看結果。其他示例的運行方法類似。

一、局部作用域

CSS的規則都是全局的,任何一個組件的樣式規則,都對整個頁面有效。

產生局部作用域的唯一方法,就是使用一個獨一無二的class的名字,不會與其他選擇器重名。這就是 CSS Modules 的做法。

下面是一個React組件App.js

import React from 'react';
import style from './App.css';

export default () => {
  return (
    <h1 className={style.title}>
      Hello World
    </h1>
  );
};

上面代碼中,我們將樣式文件App.css
輸入到style對象,然后引用style.title代表一個class

.title {
  color: red;
}

構建工具會將類名style.title編譯成一個哈希字符串。

<h1 class="_3zyde4l1yATCOkgn-DBWEL">
  Hello World
</h1>

App.css也會同時被編譯。

._3zyde4l1yATCOkgn-DBWEL {
  color: red;
}

這樣一來,這個類名就變成獨一無二了,只對App組件有效。

CSS Modules 提供各種插件,支持不同的構建工具。本文使用的是 Webpack 的css-loader
插件,因為它對 CSS Modules 的支持最好,而且很容易使用。順便說一下,如果你想學 Webpack,可以閱讀我的教程Webpack-Demos

下面是這個示例的webpack.config.js

module.exports = {
  entry: __dirname + '/index.js',
  output: {
    publicPath: '/',
    filename: './bundle.js'
  },
  module: {
    loaders: [
      {
        test: /\.jsx?$/,
        exclude: /node_modules/,
        loader: 'babel',
        query: {
          presets: ['es2015', 'stage-0', 'react']
        }
      },
      {
        test: /\.css$/,
        loader: "style-loader!css-loader?modules"
      },
    ]
  }
};

上面代碼中,關鍵的一行是style-loader!css-loader?modules,它在css-loader后面加了一個查詢參數modules,表示打開 CSS Modules 功能。

現在,運行這個Demo。

$ npm run demo01

打開http://localhost:8080 ,可以看到結果h1標題顯示為紅色。

二、全局作用域

CSS Modules 允許使用:global(.className)的語法,聲明一個全局規則。凡是這樣聲明的class,都不會被編譯成哈希字符串。

App.css
加入一個全局class

.title {
  color: red;
}

:global(.title) {
  color: green;
}

App.js
使用普通的class的寫法,就會引用全局class

import React from 'react';
import styles from './App.css';

export default () => {
  return (
    <h1 className="title">
      Hello World
    </h1>
  );
};

運行這個示例。

$ npm run demo02

打開 http://localhost:8080,應該會看到h1標題顯示為綠色。

CSS Modules 還提供一種顯式的局部作用域語法:local(.className),等同于.className,所以上面的App.css也可以寫成下面這樣。

:local(.title) {
  color: red;
}

:global(.title) {
  color: green;
}

三、定制哈希類名

css-loader默認的哈希算法是[hash:base64],這會將.title編譯成._3zyde4l1yATCOkgn-DBWEL這樣的字符串。

webpack.config.js
里面可以定制哈希字符串的格式。

module: {
  loaders: [
    // ...
    {
      test: /\.css$/,
      loader: "style-loader!css-loader?modules&localIdentName=[path][name]---[local]---[hash:base64:5]"
    },
  ]
}

運行這個示例。

$ npm run demo03

你會發現.title被編譯成了demo03-components-App---title---GpMto

四、 Class 的組合

在 CSS Modules 中,一個選擇器可以繼承另一個選擇器的規則,這稱為"組合"("composition")。

App.css
中,讓.title繼承.className

.className {
  background-color: blue;
}

.title {
  composes: className;
  color: red;
}

App.js
不用修改。

import React from 'react';
import style from './App.css';

export default () => {
  return (
    <h1 className={style.title}>
      Hello World
    </h1>
  );
};

運行這個示例。

$ npm run demo04

打開http://localhost:8080,會看到紅色的h1在藍色的背景上。

App.css編譯成下面的代碼。

._2DHwuiHWMnKTOYG45T0x34 {
  color: red;
}

._10B-buq6_BEOTOl9urIjf8 {
  background-color: blue;
}

相應地,h1class也會編譯成<h1 class="_2DHwuiHWMnKTOYG45T0x34 _10B-buq6_BEOTOl9urIjf8">

五、輸入其他模塊

選擇器也可以繼承其他CSS文件里面的規則。

another.css

.className {
  background-color: blue;
}

App.css
可以繼承another.css里面的規則。

.title {
  composes: className from './another.css';
  color: red;
}

運行這個示例。

$ npm run demo05

打開http://localhost:8080,會看到藍色的背景上有一個紅色的h1

六、輸入變量

CSS Modules 支持使用變量,不過需要安裝 PostCSS 和 postcss-modules-values

$ npm install --save postcss-loader postcss-modules-values

postcss-loader加入webpack.config.js

var values = require('postcss-modules-values');

module.exports = {
  entry: __dirname + '/index.js',
  output: {
    publicPath: '/',
    filename: './bundle.js'
  },
  module: {
    loaders: [
      {
        test: /\.jsx?$/,
        exclude: /node_modules/,
        loader: 'babel',
        query: {
          presets: ['es2015', 'stage-0', 'react']
        }
      },
      {
        test: /\.css$/,
        loader: "style-loader!css-loader?modules!postcss-loader"
      },
    ]
  },
  postcss: [
    values
  ]
};

接著,在colors.css
里面定義變量。

@value blue: #0c77f8;
@value red: #ff0000;
@value green: #aaf200;

App.css
可以引用這些變量。

@value colors: "./colors.css";
@value blue, red, green from colors;

.title {
  color: red;
  background-color: blue;
}

運行這個示例。

$ npm run demo06

打開http://localhost:8080,會看到藍色的背景上有一個紅色的h1

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,732評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,214評論 3 426
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,781評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,588評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,315評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,699評論 1 327
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,698評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,882評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,441評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,189評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,388評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,933評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,613評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,023評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,310評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,112評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,334評論 2 377

推薦閱讀更多精彩內容

  • 無意中看到zhangwnag大佬分享的webpack教程感覺受益匪淺,特此分享以備自己日后查看,也希望更多的人看到...
    小小字符閱讀 8,217評論 7 35
  • GitChat技術雜談 前言 本文較長,為了節省你的閱讀時間,在文前列寫作思路如下: 什么是 webpack,它要...
    蕭玄辭閱讀 12,706評論 7 110
  • 學習流程 參考文檔:入門Webpack,看這篇就夠了Webpack for React 一. 簡單使用webpac...
    Jason_Zeng閱讀 3,163評論 2 16
  • 盡管生活有很多的不如意,但是確實有很多可取之處,法院的工作繁忙但沒到那種累死人的程度,工資還不錯,地位好,離家近。...
    不開燈的房間s閱讀 322評論 0 1
  • 好的習慣從微小的地方開始,比如一天做一個俯臥撐,一天寫30個字。慢慢做下去,堅持做,時間長了就會形成習慣,最終會帶...
    海之覺閱讀 305評論 0 0