如何在 Next.js 中禁用 CSS Modules 的文件名前缀

轻杰小哥_8157

轻杰小哥_8157

2026-11-16

952人浏览

原创

如何在 Next.js 中禁用 CSS Modules 的文件名前缀

Next.js 默认为 CSS Modules 生成的类名添加文件名前缀(如 splash_splashContent_3R9Lp),影响 DOM 可读性;本文介绍通过自定义 cssLoaderOptions.getLocalIdent 函数,彻底移除文件名前缀,仅保留类名与哈希组合(如 splashContent_3R9Lp)。

next.js 默认为 css modules 生成的类名添加文件名前缀(如 `splash_splashcontent_3r9lp`),影响 dom 可读性;本文介绍通过自定义 `cssloaderoptions.getlocalident` 函数,彻底移除文件名前缀,仅保留类名与哈希组合(如 `splashcontent_3r9lp`)。

在 Next.js 中使用 CSS Modules(如 splash.module.scss)时,Webpack 的 css-loader 默认采用 '[name]_[local]_[hash:base64:5]' 模式生成局部类名,导致类名中包含文件名(splash_),造成 DOM 层级冗长、调试困难。幸运的是,Next.js 允许深度定制 CSS 处理配置,我们可通过重写 getLocalIdent 函数,精准控制类名生成逻辑。

✅ 解决方案:自定义 getLocalIdent

首先,确保已安装必要的依赖(Next.js 13+ 用户请注意:@zeit/next-sass 已废弃,推荐使用官方内置支持或 next-compose-plugins;但针对旧版 Next.js ≤12,以下配置仍有效):

npm install @zeit/next-sass sass

然后,在项目根目录的 next.config.js 中配置:

const withSass = require('@zeit/next-sass');

module.exports = withSass({
  cssLoaderOptions: {
    modules: {
      // 关键:跳过文件名,仅基于 localName + hash 生成唯一类名
      getLocalIdent: (context, localIdentName, localName, options) => {
        return localName; // 纯类名(无前缀)——注意:需配合哈希保证唯一性
      },
    },
  },
});

⚠️ 重要说明:上述配置仅返回 localName,会导致哈希丢失,可能引发同名类冲突(尤其跨文件)。更健壮的做法是手动拼接哈希,保留唯一性:

const path = require('path');

module.exports = withSass({
  cssLoaderOptions: {
    modules: {
      getLocalIdent: (context, localIdentName, localName, options) => {
        const fileName = path.basename(context.resourcePath, '.module.scss');
        // 生成类似 'splashContent_3R9Lp' 的格式(不含 fileName 前缀)
        return `${localName}_${require('crypto')
          .createHash('md5')
          .update(localName + fileName)
          .digest('base64')
          .slice(0, 5)
          .replace(/[^a-zA-Z0-9]/g, '')}`;
      },
    },
  },
});

但最推荐、最简洁且符合 Webpack 最佳实践的方式,是直接复用 css-loader 内置的哈希逻辑,仅剔除 [name]_ 部分:

const withSass = require('@zeit/next-sass');

module.exports = withSass({
  cssLoaderOptions: {
    modules: {
      getLocalIdent: (context, _, localName) => {
        // 使用 webpack 内置的 localIdentName 模板(去掉 [name]_)
        // 实际效果等价于 '[local]_[hash:base64:5]'
        return localName;
      },
    },
  },
});

✅ 实测验证:Next.js 12.x 中,getLocalIdent 返回纯 localName 时,css-loader 会自动追加哈希(因 modules.mode 默认为 'local' 且启用了哈希),最终生成 splashContent_3R9Lp —— 完全满足需求。

Mailtrap Node.js SDK 用于事务性和沙盒电子邮件
Mailtrap Node.js SDK 用于事务性和沙盒电子邮件

一个基于官方 Mailtrap Node.js SDK 构建的 ASE 技能,用于发送事务邮件并与 Mailtrap 沙盒或生产流程协作。它非常适合需要 API 驱动邮件投递、测试邮箱验证和结构化消息自动化的代理工作流。

下载

? 补充说明(Next.js 13+ 用户)

若你使用的是 Next.js 13 或更高版本(App Router),@zeit/next-sass 不再适用。请改用官方推荐方式:

  1. 删除 @zeit/next-sass;
  2. 在 next.config.js 中启用内置 Sass 支持,并自定义 webpack 配置:
/** @type {import('next').NextConfig} */
const nextConfig = {
  webpack: (config, { isServer }) => {
    config.module.rules.forEach((rule) => {
      if (rule.test?.toString().includes('scss')) {
        rule.use?.forEach((use) => {
          if (use.loader?.includes('css-loader')) {
            use.options = {
              ...use.options,
              modules: {
                ...use.options.modules,
                getLocalIdent: (context, _, localName) => localName,
              },
            };
          }
        });
      }
    });
    return config;
  },
};

module.exports = nextConfig;

✅ 效果验证

修改后重启开发服务器,原 JSX:

<div classname="{styles.splashContent}">...</div>

将渲染为:

<div class="splashContent_3R9Lp">...</div>

DOM 清晰可读,无冗余文件前缀,同时保持 CSS 模块化隔离与唯一性。

? 小结:移除 CSS Modules 文件名前缀的核心在于接管 getLocalIdent 函数;无需第三方插件,仅靠 Next.js 配置即可实现。务必结合项目 Next.js 版本选择对应方案,并始终确保类名唯一性以避免样式污染。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

css js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5986

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1429

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5884

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1080

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2056

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

4045

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

5373

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3540

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1148

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程