通过命名规范来限制类名太过死板,而css in js虽然足够灵活,但是书写不便。 css module 开辟一种全新的思路来解决类名冲突的问题

思路

css module 遵循以下思路解决类名冲突问题:

  1. css的类名冲突往往发生在大型项目中
  2. 大型项目往往会使用构建工具(webpack等)搭建工程
  3. 构建工具允许将css样式切分为更加精细的模块
  4. 同JS的变量一样,每个css模块文件中难以出现冲突的类名,冲突的类名往往发生在不同的css模块文件中
  5. 只需要保证构建工具在合并样式代码后不会出现类名冲突即可

image.png

实现原理

在webpack中,作为处理css的css-loader,它实现了css module的思想,要启用css module,需要将css-loader的配置modules设置为true
css-loader的实现方式如下:
image.png
原理极其简单,开启了css module后,css-loader会将样式中的类名进行转换,转换为一个唯一的hash值。
由于hash值是根据模块路径和类名生成的,因此,不同的css模块,哪怕具有相同的类名,转换后的hash值也不一样。
image.png
例子1:

  1. const HtmlWebpackPlugin = require('html-webpack-plugin')
  2. module.exports = {
  3. mode: "development",
  4. devtool: "source-map",
  5. module: {
  6. rules: [
  7. { //css-loader实现方式:例子1:
  8. // test: /\.css$/, use: ["style-loader", {
  9. // loader: "css-loader",
  10. // options: {
  11. // // modules: {
  12. // // localIdentName: "[local]-[hash:5]"
  13. // // }
  14. // modules:true
  15. // }
  16. // }]
  17. test: /\.css$/, use:["style-loader", "css-loader?modules"] //例子2
  18. }
  19. ]
  20. },
  21. plugins: [
  22. new HtmlWebpackPlugin({
  23. template: "./public/index.html"
  24. })
  25. ],
  26. devServer: {
  27. open: true
  28. }
  29. }

如何应用样式

css module带来了一个新的问题:源代码的类名和最终生成的类名是不一样的,而开发者只知道自己写的源代码中的类名,并不知道最终的类名是什么,那如何应用类名到元素上呢?
为了解决这个问题,css-loader会导出原类名和最终类名的对应关系,该关系是通过一个对象描述的
image.png
这样一来,我们就可以在js代码中获取到css模块导出的结果,从而应用类名了
style-loader为了我们更加方便的应用类名,会去除掉其他信息,仅暴露对应关系
实例2:

  1. import style1 from "./assets/style1.css"
  2. import style2 from "./assets/style2.css"
  3. /**
  4. * console.log("style1",style1)
  5. * console.log("style2",style2)
  6. */
  7. const div1 = document.getElementById("div1");
  8. div1.className = style2.c1;

其他操作

全局类名

某些类名是全局的、静态的,不需要进行转换,仅需要在类名位置使用一个特殊的语法即可:

  1. :global(.main){
  2. ...
  3. }

使用了global的类名不会进行转换,相反的,没有使用global的类名,表示默认使用了local

  1. :local(.main){
  2. ...
  3. }

使用了local的类名表示局部类名,是可能会造成冲突的类名,会被css module进行转换
例子1:
style1.css:

  1. :global(.main){
  2. background: lightblue;
  3. }

如何控制最终的类名

绝大部分情况下,我们都不需要控制最终的类名,因为控制它没有任何意义
如果一定要控制最终的类名,需要配置css-loader的localIdentName
例子1:webpack.config:

  1. module: {
  2. rules: [
  3. { //css-loader实现方式:例子1:
  4. // test: /\.css$/, use: ["style-loader", {
  5. // loader: "css-loader",
  6. // options: {
  7. // // modules: {
  8. // // localIdentName: "[local]-[hash:5]" //注意位置,可查阅文档改变
  9. // // }
  10. // modules:true
  11. // }
  12. // }]
  13. test: /\.css$/, use:["style-loader", "css-loader?modules"] //例子2
  14. }
  15. ]
  16. },

其他注意事项

  • css module往往配合构建工具使用
  • css module仅处理顶级类名,尽量不要书写嵌套的类名,也没有这个必要。例如:.c1 .c2{}只有c1改变。
  • css module仅处理类名,不处理其他选择器
  • css module还会处理id选择器,不过任何时候都没有使用id选择器的理由
  • 使用了css module后,只要能做到让类名望文知意即可,不需要遵守其他任何的命名规范