CSS Modules 用法教程

學過網頁開發就會知道，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;
}

相應地， h1的class也會編譯成<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。