學過網頁開發就會知道,CSS 不能算程式語言,只是網頁樣式的一種描述方法。
為了讓 CSS 也能適用軟體工程方法,程式設計師想了各種辦法,讓它變得像一門程式語言。從最早的Less、SASS,到後來的 PostCSS,再到最近的 CSS in JS,都是為了解決這個問題。
本文介紹的 CSS Modules 有所不同。它不是將 CSS 改造成程式語言,而是功能很單純,只加入了區域性作用域和模組依賴,這恰恰是網頁元件最急需的功能。
因此,CSS Modules 很容易學,因為它的規則少,同時又非常有用,可以保證某個元件的樣式,不會影響到其他元件。
零、示例庫
我為這個教程寫了一個示例庫,包含六個Demo。通過它們,你可以輕鬆學會CSS Modules。
首先,克隆示例庫。
1 |
$ git clone https://github.com/ruanyf/css-modules-demos.git |
然後,安裝依賴。
1 2 |
$ cd css-modules-demos $ npm install |
接著,就可以執行第一個示例了。
1 |
$ npm run demo01 |
開啟瀏覽器,訪問http://localhost:8080,檢視結果。其他示例的執行方法類似。
一、區域性作用域
CSS的規則都是全域性的,任何一個元件的樣式規則,都對整個頁面有效。
產生區域性作用域的唯一方法,就是使用一個獨一無二的class的名字,不會與其他選擇器重名。這就是 CSS Modules 的做法。
下面是一個React元件App.js。
1 2 3 4 5 6 7 8 9 10 |
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。
1 2 3 |
.title { color: red; } |
構建工具會將類名style.title編譯成一個雜湊字串。
1 2 3 |
<h1 class="_3zyde4l1yATCOkgn-DBWEL"> Hello World </h1> |
App.css也會同時被編譯。
1 2 3 |
._3zyde4l1yATCOkgn-DBWEL { color: red; } |
這樣一來,這個類名就變成獨一無二了,只對App元件有效。
CSS Modules 提供各種外掛,支援不同的構建工具。本文使用的是 Webpack 的css-loader外掛,因為它對 CSS Modules 的支援最好,而且很容易使用。順便說一下,如果你想學 Webpack,可以閱讀我的教程Webpack-Demos。
下面是這個示例的webpack.config.js。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
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。
1 |
$ npm run demo01 |
開啟 http://localhost:8080 ,可以看到結果,h1標題顯示為紅色。
二、全域性作用域
CSS Modules 允許使用:global(.className)的語法,宣告一個全域性規則。凡是這樣宣告的class,都不會被編譯成雜湊字串。
App.css加入一個全域性class。
1 2 3 4 5 6 7 |
.title { color: red; } :global(.title) { color: green; } |
App.js使用普通的class的寫法,就會引用全域性class。
1 2 3 4 5 6 7 8 9 10 |
import React from 'react'; import styles from './App.css'; export default () => { return ( <h1 className="title"> Hello World </h1> ); }; |
執行這個示例。
1 |
$ npm run demo02 |
開啟 http://localhost:8080,應該會看到h1標題顯示為綠色。
CSS Modules 還提供一種顯式的區域性作用域語法:local(.className),等同於.className,所以上面的App.css也可以寫成下面這樣。
1 2 3 4 5 6 7 |
:local(.title) { color: red; } :global(.title) { color: green; } |
三、定製雜湊類名
css-loader預設的雜湊演算法是[hash:base64],這會將.title編譯成._3zyde4l1yATCOkgn-DBWEL這樣的字串。
webpack.config.js裡面可以定製雜湊字串的格式。
1 2 3 4 5 6 7 8 9 |
module: { loaders: [ // ... { test: /.css$/, loader: "style-loader!css-loader?modules&localIdentName=[path][name]---[local]---[hash:base64:5]" }, ] } |
執行這個示例。
1 |
$ npm run demo03 |
你會發現.title被編譯成了demo03-components-App—title—GpMto。
四、 Class 的組合
在 CSS Modules 中,一個選擇器可以繼承另一個選擇器的規則,這稱為”組合”(“composition”)。
在App.css中,讓.title繼承.className 。
1 2 3 4 5 6 7 8 |
.className { background-color: blue; } .title { composes: className; color: red; } |
App.js不用修改。
1 2 3 4 5 6 7 8 9 10 |
import React from 'react'; import style from './App.css'; export default () => { return ( <h1 className={style.title}> Hello World </h1> ); }; |
執行這個示例。
1 |
$ npm run demo04 |
開啟http://localhost:8080,會看到紅色的h1在藍色的背景上。
App.css編譯成下面的程式碼。
1 2 3 4 5 6 7 |
._2DHwuiHWMnKTOYG45T0x34 { color: red; } ._10B-buq6_BEOTOl9urIjf8 { background-color: blue; } |
相應地, h1的class也會編譯成<h1 class=”_2DHwuiHWMnKTOYG45T0x34 _10B-buq6_BEOTOl9urIjf8″>。
五、輸入其他模組
選擇器也可以繼承其他CSS檔案裡面的規則。
1 2 3 |
.className { background-color: blue; } |
App.css可以繼承another.css裡面的規則。
1 2 3 4 |
.title { composes: className from './another.css'; color: red; } |
執行這個示例。
1 |
$ npm run demo05 |
開啟http://localhost:8080,會看到藍色的背景上有一個紅色的h1。
六、輸入變數
CSS Modules 支援使用變數,不過需要安裝 PostCSS 和 postcss-modules-values。
1 |
$ npm install --save postcss-loader postcss-modules-values |
把postcss-loader加入webpack.config.js。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
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裡面定義變數。
1 2 3 |
@value blue: #0c77f8; @value red: #ff0000; @value green: #aaf200; |
App.css可以引用這些變數。
1 2 3 4 5 6 7 |
@value colors: "./colors.css"; @value blue, red, green from colors; .title { color: red; background-color: blue; } |
執行這個示例。
1 |
$ npm run demo06 |
開啟http://localhost:8080,會看到藍色的背景上有一個紅色的h1。