CSS Modules

原文地址

前段时间在阅读 ant-design-pro 的源码时,发现了一种没见过的 CSS 书写方法,它能有效地解决 class 命名重复的问题。后面通过 Google 得知这是 CSS Modules,它能为 CSS 提供默认的局部作用域。

基本使用

CSS Modules 使用起来十分简单,它支持多种构建工具,这里以我在一个 React 项目中的实际使用为例进行说明。

在构建项目时使用的是 create-react-app 脚手架,通过 react-app-rewired 进行配置的修改。通过 css-loader 支持 CSS Modules,对应的 webpack 配置如下:

{
  loader: require.resolve('css-loader'),
  options: {
    modules: true,
    importLoaders: 1,
    localIdentName: '[local]___[hash:base64:5]'
  }
}

css-loader 内置了 CSS Modules,设置 modules 参数为 true 即可启用。

配置好了 CSS Modules 之后,在代码中通过下面的方式书写样式:

// 导入样式样式文件
import styles from './BasicLayout.scss';

return (
  // 导入的 styles 类似对象一样使用,将 className 作为 key
  <div className={styles.logo}>
    <h1>后台管理系统</h1>
  </div>
);

最后,渲染出来的效果如下图所示(戳原文查看图片)。

全局作用域

CSS Modules 为 CSS 提供了局部作用域,但是有时候确实需要定义一些全局的样式,这时候该怎么办呢?

CSS Modules 允许使用 :global(.className) 的语法,声明一个全局规则。凡是这样声明的 class,都不会被编译成哈希字符串。如果需要声明多个全局规则,可以使用下面这种方式:

:global {
  .clearfix {
    zoom: 1;
  }

 .clearfix:after, .clearfix:before {
    content: " ";
    display: table
  }

  .clearfix:after {
    clear: both;
    visibility: hidden;
    font-size: 0;
    height: 0
  }
}

自定义样式名

css-loader 默认生成的样式名是 [hash:base64],这会将 .title 编译成 ._3zyde4l1yATCOkgn-DBWEL 这样的字符串。我们可以通过添加 localIdentName 参数来自定义样式名的生成规则,如上面 webpack 配置中的 localIdentName: '[local]___[hash:base64:5]',这样 .title 就会被编译成 .title___fhba 这样的字符串。

样式复用

CSS Modules 让样式变得唯一了,那么我们要如何复用已有的样式呢?

CSS Modules 提供一个 composes 方法用于样式复用。例如,在 base.css 中有这样的一条样式:

.className {
  background-color: red;
}

然后,我们可以在另外一个样式文件中这样引用它:

.title {
  composes: className from './base.css';
  font-size: 18px;
}

注意事项

  • CSS Modules只转换 classid 选择器。
  • 在 js 中 styles 就像一个对象一样使用,因此如果样式名为 .site-wrapper,那么在使用时应该写成 styles['site-wrapper']。我们可以设置 css-loader 的 camelCase 参数为 true 来启动自动转换,这样在 js 中就可以通过 styles.siteWrapper 使用。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,904评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,581评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,527评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,463评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,546评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,572评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,582评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,330评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,776评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,087评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,257评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,923评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,571评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,192评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,436评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,145评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容