怎么在Next.js中正确配置SCSS支持CSS Modules

大宇姑娘_4978

大宇姑娘_4978

2026-10-03

483人浏览

原创

next.js 13+ 原生支持 .module.scss,无需额外配置;错误使用旧插件或 next.config.js 中的过时配置会导致样式失效、无作用域或构建失败。

怎么在next.js中正确配置scss支持css modules

Next.js 13+ 默认支持 .module.scss,无需额外配置

Next.js 自 v13 起已原生支持 CSS Modules,包括 .module.scss 和 .module.sass 文件,只要文件名符合 *.module.scss 规范,就能直接 import 并获得作用域类名映射。不需要安装 node-sass、@zeit/next-sass 等旧插件,也不需要在 next.config.js 中写 webpack override 或调用 withSass。

常见错误是沿用 Next.js 12 及更早的配置思路,手动引入过时的插件包——这反而会破坏默认行为,导致样式不哈希、无作用域,甚至构建失败。

  • ✅ 正确做法:直接创建 Button.module.scss,然后 import styles from './Button.module.scss'
  • ❌ 错误做法:npm install @zeit/next-sass + 修改 next.config.js,或在 next.config.js 中显式设置 cssModules: true
  • ⚠️ 注意:.scss(无 module)文件不能在组件内 import,只允许在 app/layout.tsx 中全局导入

.module.scss 的命名与引用必须严格匹配

SCSS 中定义的类名(如 .toolbar-container)会被 Next.js 自动转换为驼峰式属性名(styles.toolbarContainer),但这个转换仅在类名合法且无歧义时生效。如果写成 styles.toolbar-container,JS 会报语法错误(- 被解析为减号);如果拼写不一致(比如 SCSS 里是 .tool-bar,JS 里写 styles.toolbar),结果就是 undefined。

  • SCSS 文件中类名必须用连字符分隔,例如:.form-control-group、.btn-primary
  • TS/JS 中必须用驼峰式访问:styles.formControlGroup、styles.btnPrimary
  • 不要试图用方括号动态访问:styles['form-control-group'] 在类型检查下不可靠,且失去自动补全
  • 嵌套规则不影响类名生成,只影响最终 CSS 输出;.btn { &--large { ... } } 仍需按 styles.btnLarge 访问

Storybook 中 .module.scss 同样开箱即用

如果你在用 @storybook/nextjs,那么 .module.scss 不仅在 Next.js 应用中工作,在 Storybook 预览环境中也完全可用,无需任何 loader 配置或 main.ts 覆盖。

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载

这是因为 Storybook 的 Next.js 框架内部复用了 Next.js 自身的 webpack 规则(见 @storybook/nextjs/dist/frameworks/nextjs/css/webpack.ts),对 .module.scss 的处理逻辑与 Next.js 构建过程一致。

  • ✅ 示例写法:
    import styles from './Card.module.scss'; return <div classname="{styles.cardWrapper}">...</div>;
  • ⚠️ 注意:Storybook 不支持 .scss(非 module)在 stories 中直接 import,和 Next.js 行为一致
  • ? 如果你看到样式丢失,优先检查是否误用了 .scss 后缀而非 .module.scss

遇到 ReferenceError: require is not defined 怎么办

这个错误通常出现在你误装了旧版 @zeit/next-sass 或 next-sass,它们依赖 Node.js 的 require,而 App Router 环境(尤其是 Server Components)运行在 ESM 模式下,不支持 require。

  • 立即执行:npm rm @zeit/next-sass next-sass node-sass sass-loader
  • 删掉 next.config.js 中所有与 withSass、withCSS 相关的代码
  • 确认 next.config.js 里没有 cssModules: true 或自定义 webpack 的 module.rules 针对 scss
  • 重启 dev server:Next.js 默认配置会接管所有 *.module.scss 文件,并交由 postcss + css-loader + sass(内置)处理

真正容易被忽略的是:哪怕你没主动 import 任何 scss 相关插件,只要 next.config.js 里残留了旧式配置,就可能触发降级行为,让 .module.scss 被当成普通 CSS 处理——类名不哈希、无作用域、无法热更新。

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

相关文章

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

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

下载

相关标签:

css js

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

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

4196

6

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

937

5

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.28

1778

6

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

2023.08.01

3306

7

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

2023.08.10

6565

11

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

2023.08.10

5591

7

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

2023.08.21

1917

9

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

2023.08.22

2651

5

css禁止点击事件
css禁止点击事件

实现css禁止点击事件的方法有使用CSS的pointer-events属性和使用JavaScript禁用点击事件。本专题为大家提供点击事件相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2293

5

热门下载

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

精品课程

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

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 5.8万人学习

CSS教程
CSS教程

共754课时 | 95.6万人学习