当前位置：首页 > article >正文

CSS Module：告别类名冲突，拥抱模块化样式（5）

article 2024/11/16 12:59:36

CSS Module 是一种解决 CSS 类名冲突的全新思路。它通过构建工具（如 webpack）将 CSS 样式切分为更加精细的模块，并在编译时将类名转换为唯一的标识符，从而避免类名冲突。本文将详细介绍 CSS Module 的实现原理和使用方法。

1. 思路

CSS Module 遵循以下思路解决类名冲突问题：

类名冲突：类名冲突往往发生在大型项目中。
构建工具：大型项目往往会使用构建工具（如 webpack）搭建工程。
模块化：构建工具允许将 CSS 样式切分为更加精细的模块。
变量机制：同 JS 的变量一样，每个 CSS 模块文件中难以出现冲突的类名，冲突的类名往往发生在不同的 CSS 模块文件中。
避免冲突：只需要保证构建工具在合并样式代码后不会出现类名冲突即可。

2. 实现原理

在 webpack 中，作为处理 CSS 的 css-loader，它实现了 CSS Module 的思想。要启用 CSS Module，需要将 css-loader 的配置 modules 设置为 true。

css-loader的实现方式如下：
在这里插入图片描述

原理极其简单，开启了css module后，css-loader会将样式中的类名进行转换，转换为一个唯一的hash值。

由于hash值是根据模块路径和类名生成的，因此，不同的css模块，哪怕具有相同的类名，转换后的hash值也不一样。

在这里插入图片描述

3. 如何应用样式

css module带来了一个新的问题：源代码的类名和最终生成的类名是不一样的，而开发者只知道自己写的源代码中的类名，并不知道最终的类名是什么，那如何应用类名到元素上呢？

为了解决这个问题，css-loader会导出原类名和最终类名的对应关系，该关系是通过一个对象描述的
在这里插入图片描述

3.1 示例

假设有一个 CSS 文件 style.css：

.red {
  color: #f40;
}

在 JS 文件中，可以这样导入和应用类名：

import React from 'react';
import styles from './style.css';

function App() {
  return (
    <div className={styles.red}>
      Hello, World!
    </div>
  );
}

export default App;

4. 其他操作

4.1 全局类名

某些类名是全局的、静态的，不需要进行转换。可以在类名位置使用 :global 语法：

:global(.main) {
  /* 全局样式 */
}

使用了 :global 的类名不会进行转换，相反的，没有使用 :global 的类名，默认使用 :local：

:local(.main) {
  /* 局部样式 */
}

4.2 控制最终的类名

大部分情况下，我们不需要控制最终的类名，因为控制它没有任何意义。如果一定要控制最终的类名，可以配置 css-loader 的 localIdentName。

例如：

module.exports = {
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [
          'style-loader',
          {
            loader: 'css-loader',
            options: {
              modules: true,
              localIdentName: '[local]_[hash:base64:5]'
            }
          }
        ]
      }
    ]
  }
};