初识CSS Modules

2019-09-16 05:39 来源:未知

一、局部作用域

CSS的规则都是全局的,任何一个组件的样式规则,都对整个页面有效。

产生局部作用域的唯一方法,就是使用一个独一无二的class的名字,不会与其他选择器重名。这就是 CSS Modules 的做法。

下面是一个React组件App.js。

JavaScript

import React from 'react'; import style from './App.css'; export default () => { return ( <h1 className={style.title}> Hello World </h1> ); };

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。

CSS

.title { color: red; }

1
2
3
.title {
  color: red;
}

构建工具会将类名style.title编译成一个哈希字符串。

XHTML

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

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

App.css也会同时被编译。

JavaScript

._3zyde4l1yATCOkgn-DBWEL { color: red; }

1
2
3
._3zyde4l1yATCOkgn-DBWEL {
  color: red;
}

这样一来,这个类名就变成独一无二了,只对App组件有效。

CSS Modules 提供各种插件,支持不同的构建工具。本文使用的是 Webpack 的css-loader插件,因为它对 CSS Modules 的支持最好,而且很容易使用。顺便说一下,如果你想学 Webpack,可以阅读我的教程Webpack-Demos。

下面是这个示例的webpack.config.js。

JavaScript

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
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。

JavaScript

$ npm run demo01

1
$ npm run demo01

打开 ,可以看到结果,h1标题显示为红色。

webpack 之 css module

CSS modules来了

要说js模块化,这几年真是讲烂了,什么AMD,CMD,UMD各种,以及ES2015原生都开始支持js模块化。讲真,在我开始接触了模块化js之后确实给我带来了很多的方便(点个赞)。
同样,CSS module的带来或许也可能解决目前大家最头疼的CSS 全局污染问题了。

四、 Class 的组合

在 CSS Modules 中,一个选择器可以继承另一个选择器的规则,这称为”组合”(“composition”)。

在App.css中,让.title继承.className 。

JavaScript

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

1
2
3
4
5
6
7
8
.className {
  background-color: blue;
}
 
.title {
  composes: className;
  color: red;
}

App.js不用修改。

JavaScript

import React from 'react'; import style from './App.css'; export default () => { return ( <h1 className={style.title}> Hello World </h1> ); };

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

运行这个示例。

JavaScript

$ npm run demo04

1
$ npm run demo04

打开

App.css编译成下面的代码。

JavaScript

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

1
2
3
4
5
6
7
._2DHwuiHWMnKTOYG45T0x34 {
  color: red;
}
 
._10B-buq6_BEOTOl9urIjf8 {
  background-color: blue;
}

相应地, h1的class也会编译成<h1 class=”_2DHwuiHWMnKTOYG45T0x34 _10B-buq6_BEOTOl9urIjf8″>。

引入其他模块:
composes: classname from ’./style.css’;

言归正传

我取标题的能力也是挺瞎的……


引言吐槽了一下javascript的蓬勃发展,其实并非是坏事,例如ES2015的发布和使用确实让我感受到敲代码时候很大的方便,比如箭头函数(笑)。但相对而言的,CSS的发展却并不是那么快。
可以想到的无非是各种预处理器

  • LESS
  • SASS
  • 以及以后比较流行的postcss

但是他们还是没有解决一个问题,命名的痛苦……

试想一下,一个大的项目,css命名满天飞,一不留神就覆盖了全局的class名怎么办?

** css究竟怎么了?**

  1. 全局污染
  2. 命名混乱
  3. 依赖管理不彻底

CSS Modules 用法教程

2016/06/19 · CSS · Modules

原文出处: 阮一峰   

学过网页开发就会知道,CSS 不能算编程语言,只是网页样式的一种描述方法。

为了让 CSS 也能适用软件工程方法,程序员想了各种办法,让它变得像一门编程语言。从最早的Less、SASS,到后来的 PostCSS,再到最近的 CSS in JS,都是为了解决这个问题。

图片 1

本文介绍的 CSS Modules 有所不同。它不是将 CSS 改造成编程语言,而是功能很单纯,只加入了局部作用域和模块依赖,这恰恰是网页组件最急需的功能。

因此,CSS Modules 很容易学,因为它的规则少,同时又非常有用,可以保证某个组件的样式,不会影响到其他组件。

图片 2

class组合:
composes:classname;

CSS modules 使用实例

*这里使用 webpack *

项目结构

  • src (文件夹)
  • node_modules (文件夹)
  • .babelrc
  • index.html
  • webpack.config.js
  • package.json

假设项目的文件夹是 app, 在app文件夹内npm init 生成 package.json 文件
然后(请确认已全局安装webpack), npm install -D babel-core babel-loader babel-preset-es2015 extract-text-webpack-plugin css-loader webpack

在webpack.config.js中写入以下内容

var path = require('path')
var ExtractTextPlugin = require("extract-text-webpack-plugin");

module.exports = {
    entry: './src',
    output: {
        path: 'bulid',
        filename: 'bundle.js'
    },
    module: {
        loaders: [{
            test: /.js$/,
            loader: 'babel-loader',
            include: path.resolve(__dirname, './src')
        }, {
            test: /.css$/,
            loader: ExtractTextPlugin.extract('css?modules&importLoaders=1&localIdentName=[name]__[local]___[hash:base64:5]'),
            include: path.resolve(__dirname, 'src'),
        }]
    },
    plugins: [
        new ExtractTextPlugin("styles.css")
    ],
    devtool: "source-map"
}

在.babelrc文件中写入

{
 "presets": ["es2015"]
}```

在index.html中写入

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document name</title>
<link rel="stylesheet" href="bulid/styles.css">
</head>
<body>
<h1>CSS Modules demo</h1>

<script src="bulid/bundle.js"></script>

</body>
</html>

准备工作做完,我们在src文件夹中进行具体的内容操作

###### step1 
在src中新建 index.js,内容

import buttons from './buttons.css'

let element = <div class="${buttons.red}"> <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Consequatur laudantium recusandae itaque libero velit minus ex reiciendis veniam. Eligendi modi sint delectus beatae nemo provident ratione maiores, voluptatibus a tempore!</p> </div>;
document.write(element);

###### setp2 
在src文件夹中新建buttons.css,内容

.red{
color:red
}

###### setp3 
在命令行中执行webpack任务,生成bulid文件夹。

命令行 输入   ```webpack``` 尝试一下吧!!
***
在上述的项目中,css modules的核心是webpack.config.js中 

{
test: /.css$/,
loader: ExtractTextPlugin.extract('css?modules&importLoaders=1&localIdentName=[name][local]_[hash:base64:5]'),
include: path.resolve(__dirname, 'src'),
}

# 文章参考
[CSS Modules入门Ⅰ:它是什么?为什么要使用它?
](https://zhuanlan.zhihu.com/p/23571898)
[CSS Modules入门Ⅱ:快速上手](https://zhuanlan.zhihu.com/p/23602046)
[CSS Modules 用法教程](http://www.bshare.cn/share)

六、输入变量

CSS Modules 支持使用变量,不过需要安装 PostCSS 和 postcss-modules-values。

JavaScript

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

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

把postcss-loader加入webpack.config.js。

JavaScript

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

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里面定义变量。

JavaScript

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

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

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

JavaScript

@value colors: "./colors.css"; @value blue, red, green from colors; .title { color: red; background-color: blue; }

1
2
3
4
5
6
7
@value colors: "./colors.css";
@value blue, red, green from colors;
 
.title {
  color: red;
  background-color: blue;
}

运行这个示例。

JavaScript

$ npm run demo06

1
$ npm run demo06

打开

1 赞 3 收藏 评论

图片 3

引入:
import style from './App.css';
style.title{}

3. 定制哈希类名

配合webpack食用更佳
举个配合webpack使用的例子

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

依然是上面的例子
创建一个button.css文件,并写入代码

.red{
   color:red  
}

那么,渲染的class可能是 .buttons__red___3N_PG

三、定制哈希类名

css-loader默认的哈希算法是[hash:base64],这会将.title编译成._3zyde4l1yATCOkgn-DBWEL这样的字符串。

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

JavaScript

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

1
2
3
4
5
6
7
8
9
module: {
  loaders: [
    // ...
    {
      test: /.css$/,
      loader: "style-loader!css-loader?modules&amp;localIdentName=[path][name]---[local]---[hash:base64:5]"
    },
  ]
}

运行这个示例。

JavaScript

$ npm run demo03

1
$ npm run demo03

你会发现.title被编译成了demo03-components-App—title—GpMto。

定制css类名规则
modules&localIdentName=[path][name]---[local]---[hash:base64:5]
localIdentName 字段定义css类名规则

前端的发展太快了,之前拜读了一篇在 2016 年学 JavaScript 是一种什么样的体验?,不禁感慨,放一个三年前的前端来看待现在的前端圈子,估计也是懵逼的。

二、全局作用域

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

App.css加入一个全局class。

JavaScript

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

1
2
3
4
5
6
7
.title {
  color: red;
}
 
:global(.title) {
  color: green;
}

App.js使用普通的class的写法,就会引用全局class。

JavaScript

import React from 'react'; import styles from './App.css'; export default () => { return ( <h1 className="title"> Hello World </h1> ); };

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

运行这个示例。

JavaScript

$ npm run demo02

1
$ npm run demo02

打开

CSS Modules 还提供一种显式的局部作用域语法:local(.className),等同于.className,所以上面的App.css也可以写成下面这样。

JavaScript

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

1
2
3
4
5
6
7
:local(.title) {
  color: red;
}
 
:global(.title) {
  color: green;
}

引入变量:(postcss-loader ;postcss-modules-values)

2. 全局作用域

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

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

第二个渲染的class依然是.title

CSS Modules 还提供一种显式的局部作用域语法:local(.className),等同于.class,所以上述的css文件也可以写成下面这样。

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

零、示例库

我为这个教程写了一个示例库,包含六个Demo。通过它们,你可以轻松学会CSS Modules。

首先,克隆示例库。

JavaScript

$ git clone

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

然后,安装依赖。

JavaScript

$ cd css-modules-demos $ npm install

1
2
$ cd css-modules-demos
$ npm install

接着,就可以运行第一个示例了。

JavaScript

$ npm run demo01

1
$ npm run demo01

打开浏览器,访问

  1. web pack配置增加 postcss: [require('postcss-modules-values') ]
  2. 语法(注意‘: ’ 号后空格,去掉会报错!)
    @value green: #aaf200; 定义变量
    @value colors: "./colors.css";
    @value blue, red, green from colors;
1. 局部作用域

说白了,使用CSS modules ,每一个class都可以生成一个唯一的class名

例如
创建一个button.css文件,并写入代码

.red{
   color:red  
}

引入到另一个index.js(省略了一部分代码)

import buttons from "./buttons.css";
element.innerHTML = `<div class="${buttons.red}">`

那么,在渲染到html文件里面的时候,这里的class可能就是_3N_PGYCwi_3X8rf_WN50yo(命名规则其实是可以自行调整的,下面会提到)

五、输入其他模块

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

another.css

JavaScript

.className { background-color: blue; }

1
2
3
.className {
  background-color: blue;
}

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

JavaScript

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

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

运行这个示例。

JavaScript

$ npm run demo05

1
$ npm run demo05

打开

webpack配置
css-loader?modules
modules 字段表示开启css module

5. 输入变量

接触不多,具体实现详见原文。

全局:
:global()
eg:
:global(.title){}

怎么办,试试BEM呗

你还真别说,业界确实有一个非常不错的css命名规范,BEM(不展开了),有兴趣的自行搜索一下吧,BEM规范的好处在于尽可能的解决了css命名全局污染的问题。但是,它的规则真的太麻烦了,还不好记。

举个例子

.block{} /* 块 */
.block__element{} /* 元素 */
.block--modifier{} /* 修饰符 */

啥都别说了……

4. Class 的组合

在 CSS Modules 中,一个选择器可以继承另一个选择器的规则,这称为"组合"("composition")。

直接上代码
创建一个button.css文件,并写入代码

.red{
   color:red  
}
.button{
  composes:red
}

使用composes继承了class名为red的属性,有点类似于sass里面的@extend。

此外还支持两个模块的引入
例如
创建一个button.css文件,并写入代码

.red{
   color:red  
}

同目录创建一个button2.css文件,并写入代码

.button{
  composes:red from './button.css'
}

通过** composes:red from './button.css'**实现了两个文件之间的组合。

CSS modules语法篇

一切开始前,要表示一下,CSS modules不是一个新语言,而只是CSS in JS一直实现方式,最值得重视的是,它的规则特别少,几乎0成本!这部分参考了阮一峰大神的CSS Modules 用法教程

TAG标签: css 前端
版权声明:本文由彩民之家高手论坛发布于前端知识,转载请注明出处:初识CSS Modules