Skip to main content

CSS模块语法

@import

@import url list-of-media-queries

@import是 CSS 里用于引入其他 CSS 文件的模块化语法。

url:其他样式表的相对路径或者绝对路径,或者使用url()函数

list-of-media-queries:媒体查询条件,指定以后会让浏览器决定是否引入该 CSS 规则

@import 'custom.css';
@import url('chrome://communicator/skin/');
@import url('landscape.css') screen and (orientation: landscape);

什么是 CSS Modules

根据CSS Module的介绍,一个 CSS Module 就是一个 CSS 文件,在当前文件中的classanimation会被限制在当前模块作用域内。所有在url()@import url()设置的路径也会是相当于 CSS Module 文件所在路径。

本质上来说,CSS 并不会存在作用域,CSS Module 是使用全局唯一的 hash 值替换原有的class或者id名称来达到解决命名冲突等问题,也就相当于限定了模块作用域。

CSS Modules 语法

CSS 对象

如果在 JS 中import一个 CSS Module 文件,CSS Module 会export一个对象,保存着当前 JS 模块内部class命名和产生的全局名称的映射关系。

/* style.css */
.btn {
}

.user-login {
}
import styles from './style.css';

export default class extends Component {
render() {
return (
<div className={styles['user-login']}>
<button className={styles.btn}>按钮</button>
</div>
);
}
}

驼峰命名

CSS class的命名建议使用驼峰命名形式,但是 CSS 命名广泛采用的是烤肉串形式也可以,对于烤肉串形式的class名称需要上面示例那样的方括号[]去访问。常见的命名格式:

  • camelCase:也就是驼峰格式,第一个单词的首字母需要小写,其余单词首字母大写,例如
.userLogin {
}
  • PascalCase:帕斯卡命名格式,所有单词首字母必须大写,例如
.UserLogin {
}
  • snakecase:(蛇形)要求使用下划线``连接所有单词,要大写就全部大写,要小写就全部小写,例如
.user_login {
}
  • kebab-case:(烤肉串形式)要求使用连字符-连接所有单词,一般来说在 CSS 里广泛使用的是这种形式,例如
.user-login {
}

local 和 global

CSS Modules 默认是对类名自动添加:local(...) 的模块作用域;也允许使用:global()切换到全局作用域,下面是两种形式的使用,:global()包裹的class或者id不会被 hash 处理,也就不具有模块作用域了。

:global(.btn) {
background: green;
}

.p {
color: red;
}
import styles from "./styles.css";

<button className="btn" onClick={this.handleClick}>
<p className={styles.p}>{this.state.value}</p>

image-20200916160422829

如果使用less预处理器,那么:global()还支持嵌套的语法:

:global {
.global-class-name {
color: green;
}
}

组合 class

使用composes可以继承已经存在的class定义,最终在 HTML 标签上定义的class会是几个 class 名称组合在一起

.p {
font-size: 20px;
}

.p1 {
composes: p;
color: red;
}

image-20200916161443996

同时也支持继承其它文件的class规则,但是要注意不要为来自不同文件的多个类名中的同一属性定义不同的值。而且还需要注意避免循环依赖的问题,所以通常一般不建议这么干

.otherClassName {
composes: className from './style.css';
}

使用 CSS Modules

css-loader

CSS Modules 需要构建工具的支持,以 webpack 为例,需要使用css-loader来处理,这在搭建 React 项目中提到过。css-loader默认是对匹配/\.module\.\w+$/i(也就是以.module形式命名,例如style.module.css)的 CSS 文件使用 CSS Modules 的处理规则,CRA 就是用的这样的默认配置。

modules 配置项

通过css-loadermodules配置项可以自定义 webpack 对 CSS Modules 的支持,该配置项默认值是基于文件名,对匹配/\.module\.\w+$/i的 CSS 模块为true

Boolean

如果直接设置成true就表示在 JS 引入的 CSS 都会看作 CSS Module 去处理,那么就需要按照 CSS Module 的语法了。设置为 false 值会提升 webpack 构建的性能,因为避免了 webpack 去额外处理 CSS Module 的语法。

module.exports = {
module: {
rules: [
{
test: /\.css$/i,
loader: 'css-loader',
options: {
modules: true,
},
},
],
},
};

String

可选"local"或者"global",指定"local"的效果和true是一样的,指定"global"不会对 CSS Modules 的class进行 hash 编码,直接使用原来的class名称,也就是不具有模块作用域。需要注意的是设置"global"就要按照 CSS Modules global 的语法来写,详情见上文localglobal的区别。

Object

可以传入一个对象来设置不同的属性值。

module.exports = {
module: {
rules: [
{
test: /\.css$/i,
loader: 'css-loader',
options: {
esModule: true,
modules: {
auto: true,
localIdentName: isDevelopment
? '[path][name]__[local]'
: '[hash:base64]',
},
},
},
],
},
};
属性类型默认值含义
compileTypeString"module"控制样式的编译级别
auto`BooleanRegExpFunction`
mode`StringFunction`"local"
localIdentNameString[hash:base64]设置 CSS Module 转换后的class名称形式
localIdentContextString定义 loader 的当前执行上下文,默认是 webpack 的执行上下文配置
localIdentHashPrefixStringundefined设置转换后名称的前缀形式
localIdentRegExp`StringRegExp`undefined
getLocalIdentFunctionundefined
namedExportBooleanfalse是否使用 ES module 进行 CSS 模块导出,这个配置项已经没用了
exportGlobalsBooleanfalse允许 css-loader 从全局类或 ID 导出名称
exportlocalsConventionString"asIs"导出的类名称的样式,默认是按照原来的class或者id名称,其他可选的值如下表所示
exportOnlyLocalsBooleanfalse仅导出局部环境

exportlocalsConvention的可选值:

名称类型描述
'asIs'{String}类名将按原样导出。
'camelCase'{String}类名将被驼峰化,原类名不会从局部环境删除
'camelCaseOnly'{String}类名将被驼峰化,原类名从局部环境删除
'dashes'{String}类名中只有破折号会被驼峰化
'dashesOnly'{String}类名中破折号会被驼峰,原类名从局部环境删除

React CSS Modules

React CSS Modules

React CSS Modules 其实和 CSS Module 差不多,从 React CSS Modules 介绍文档里来看,CSS Module 存在以下问题:

  • 在 React 中使用时,必须以styles对象的形式导入 CSS;且className也必须用对象属性的形式;
  • 模块 CSS 和全局 CSS 混合在一起会很难维护
  • 引用未定义 CSS 模块没有任何警告信息

react-css-modules是一个高阶组件,它使用styleName替代 React 中的className,并且在 webpack 打包的时候,利用styleName去找样式对象中的 CSS 模块,并把这些模块的属性再填充到className中,个人看法,比原始 CSS Module 还麻烦一点。

import React from 'react';
import CSSModules from 'react-css-modules';
import styles from './table.css';

class Table extends React.Component {
render() {
return (
<div styleName="table">
<div styleName="row">
<div styleName="cell">A0</div>
<div styleName="cell">B0</div>
</div>
</div>
);
}
}

export default CSSModules(Table, styles);

babel-plugin-react-css-modules

babel-plugin-react-css-modules

babel-plugin-react-css-modules是一个 babel 的 plugin,能在解析 CSS 模块的时候,自动将styleName转换成className

相比react-css-modules,用法更简单,体积更小,性能也更好。

原理

  • 为每个在 React 导入的.css或者.scss文件创建索引;
  • 使用 postcss 将匹配的 CSS 文件解析为对 CSS 模块引用的查找;
  • 遍历所有 JSX 元素的定义;
  • styleName属性值解析为匿名和命名 CSS 模块引用
  • 查找与 CSS 模块匹配的 CSS 类名称
  • 从元素中删除styleName属性
  • className属性插入到 JSX 元素中

配置项

配置项类型默认值含义
contextString必须和 webpack 的context配置项想匹配
excludeString排除的文件名,例如node_modules
filetypesString配置 PostCSS 使用的其它 CSS 预处理的 loader
generateScopedNameString"[path]___[name]__[local]___[hash:base64:5]"配置转换后的class或者id的名称,必须和css-loaderlocalIdentName一致
removeImportBooleanfalse删除匹配的样式导入。此选项用于启用服务器端渲染
webpackHotModuleReloadingBooleanfalse启用 webpack 中 CSS 的热重载
handleMissingStyleNameString"throw"在 React 中使用了未定义的 CSS 时候的提示;"throw"会抛出错误,会被 WDS 捕获,"warn"仅在 CLI 中提示,"ignore"会直接忽略
attributeNamesObject{"styleName": "className"}自定义插件转换 JSX 属性的映射关系
skipbooleanfalse如果在文件中找不到匹配的属性名,是否应用插件
autoResolveMultipleImportsbooleanfalse允许使用命名规则从多个引入的 CSS 文件中导出 CSS 对象

使用

yarn add babel-plugin-react-css-modules -D
module.exports = {
module: {
rules: [
{
test: /\.m?jsx?$/,
exclude: /(node_modules)/,
loader: 'babel-loader',
options: {
plugins: [
'@babel/plugin-transform-runtime',
'@babel/plugin-proposal-class-properties',
[
'react-css-modules',
{
generateScopedName: isDevelopment
? '[path][name]__[local]'
: '[hash:base64]',
webpackHotModuleReloading: true,
handleMissingStyleName: 'warn',
},
],
],
},
},
],
},
};
import React from 'react';
import './table.css';

export default class Table extends React.Component {
render() {
return (
<div styleName="table">
<div styleName="row">
<div styleName="cell">A0</div>
<div styleName="cell">B0</div>
</div>
</div>
);
}
}

如果是同时引入多个 CSS Module,可以使用具体的对象引用class

import foo from './foo1.css';
import bar from './bar1.css';

<div styleName="foo.a"></div>;

<div styleName="bar.a"></div>;