CSS Modules 用法

局部作用域

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 的支持最好，而且很容易使用。

示例配置

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"
      },
    ]
  }
};

但个人认为使用下面这种方法更加好些。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
module: {
  loaders: [
    {
	  test: /\.jsx?$/,
      loader: 'babel-loader',
	  exclude: [
	    path.resolve(__dirname, "/node_modules/")
	  ],
	  query: {
	    presets: ['es2015','react']
	  }
	},
	{
	  test: /\.css$/,
	  use: [
	        { loader: "style-loader" },
	        {loader: "css-loader",options: {modules: true}}
	    ]
	}
  ]
},

上面代码中，关键的一行是 style-loader!css-loader?modules ，它在 css-loader 后面加了一个查询参数 modules ，表示打开 CSS Modules 功能。

全局作用域

CSS Modules 允许使用 :global(.className) 的语法，声明一个全局规则。凡是这样声明的class，都不会被编译成哈希字符串。

App.css加入一个全局class。

1
2
3
4
5
6
7
.title {
  color: red;
}

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

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
{
     loader: 'css-loader',
     options: {
       modules: true,
       localIdentName: '[path][name]__[local]--[hash:base64:5]'
     }
}

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;
}

输入其他模块

选择器也可以继承其他 CSS 文件里面的规则。

App.css 可以继承 another.css 里面的规则。

1
2
3
4
.title {
  composes: className from './another.css';
  color: red;
}

输入变量

CSS Modules 支持使用变量，不过需要安装 postcss-loader 和 postcss-modules-values

1
npm install postcss-loader postcss-modules-values --save-dev

1
2
3
4
{
    test: /\.css$/,
    loader: "style-loader!css-loader?modules!postcss-loader"
}

接着，在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;
}