开始

image.png

首先克隆demo，安装依赖。

  1. $ git clone https://github.com/ruanyf/css-modules-demos.git
  3. $ cd css-modules-demos
  5. $ cnpm install

其次运行demo

  1. $ npm run demo01

打开浏览器，访问http://localhost:8080，查看结果。

详解

局部作用域

CSS的规则都是全局的，任何一个组件的样式规则，都对整个页面有效。
产生局部作用域的唯一方法，就是使用一个独一无二的**class**的名字，不会与其他选择器重名。这就是 CSS Modules 的做法。

demo1实现了以下内容

  1. <h1 class="_3zyde4l1yATCOkgn-DBWEL">
  2.   Hello World
  3. </h1>

App.css也会同时被编译。

._3zyde4l1yATCOkgn-DBWEL {
  color: red;
}

CSS Modules 提供各种插件，支持不同的构建工具。本文使用的是 Webpack 的css-loader插件，因为它对 CSS Modules 的支持最好，而且很容易使用。

观察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 功能。

全局作用域

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

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

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

你会发现.title被编译成了demo03-components-App---title---GpMto。
demo03-components 是 [path]
App 是 [name]
title 是 [local]
GpMto 是 [hash:base64:5]

Class 的组合

在 CSS Modules 中，一个选择器可以继承另一个选择器的规则，这称为”组合”（”composition”）。
在App.css中，让.title继承.className 。

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

composes实现了css的继承。

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

输入变量

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 blueDefault: #0c77f8;
@value redDefault: #ff0000;
@value greenDefault: #aaf200;

App.css可以引用这些变量。

@value colors: "./colors.css";
@value blueDefault, redDefault, greenDefault from colors;
.title {
  color: redDefault;
  background-color: blueDefault;
}

参考

  1. CSS Modules 用法教程