export default {
output: {
cssModules: {
auto: (resource) => {
return resource.includes('.module.') || resource.includes('shared/');
cssModules.exportLocalsConvention
导出的 class 名称的命名风格。
type CSSModulesLocalsConvention =
| 'asIs'
| 'camelCase'
| 'camelCaseOnly'
| 'dashes'
| 'dashesOnly';
默认值: 'camelCase'
类型说明:
asIs
:类名将按原样导出。
camelCase
:类名将被驼峰化,然后被导出。原始类名也会被导出。
camelCaseOnly
:类名将被驼峰化,然后被导出。原始类名不会被导出。
dashes
:只有类名中的破折号会被驼峰化,然后被导出。原始类名也会被导出。
dashesOnly
:类名中的破折号会被驼峰化,然后被导出。原始类名不会被导出。
export default {
output: {
cssModules: {
exportLocalsConvention: 'camelCaseOnly',
cssModules.exportGlobals
类型: boolean
默认值: false
允许从 global class names 导出名称,以便你可以通过 import 使用它们。
将 exportGlobals
设置为 true
:
export default {
output: {
cssModules: {
exportGlobals: true,
在 CSS Modules 中使用 :global()
:
style.module.css
:global(.blue) {
color: blue;
.red {
color: red;
然后你可以导入 :global()
包裹的类名:
Button.tsx
import styles from './style.module.css';
console.log(styles.blue); // 'blue'
console.log(styles.red); // 'red-[hash]'
cssModules.localIdentName
类型: string
const localIdentName =
rsbuildConfig.mode === 'production'
? '[local]-[hash:base64:6]'
: '[path][name]__[local]-[hash:base64:6]';
设置 CSS Modules 编译后生成的 class names 格式。
默认值
localIdentName
在开发模式和生产模式有不同的默认值。
在生产模式,Rsbuild 会生成更简短的类名,从而减少构建产物的体积。
import styles from './index.module.scss';
// 在开发模式下,值为 `src-index-module__header-[hash]`
// 在生产模式下,值为 `header-[hash]`
console.log(styles.header);
模板字符串
在 localIdentName
中,你可以使用以下模板字符串:
[name]
- 源文件名称。
[local]
- 原始类名。
[hash]
- 字符串的哈希值。
[folder]
- 文件夹的相对路径。
[path]
- 源文件的相对路径。
[file]
- 文件名和路径。
[ext]
- 文件后缀名,包含点号。
[hash:<hashDigest>:<hashDigestLength>]
- 带有哈希设置的哈希。
将 localIdentName
设置为其他值:
export default {
output: {
cssModules: {
localIdentName: '[hash:base64:4]',
cssModules.mode
type Mode =
| 'local'
| 'global'
| 'pure'
| 'icss'
| ((resourcePath: string) => 'local' | 'global' | 'pure' | 'icss');
默认值: 'local'
控制 CSS Modules 的编译模式。
可选值
cssModules.mode
可以取以下值之一:
'local'
(默认值):启用 CSS Modules 规范和局部作用域。类名和 ID 选择器会被重写为模块作用域,并注入 @value
绑定。
'global'
:不启用 CSS Modules 的行为,禁用局部作用域和 @value
绑定注入。全局选择器将按照原样保留。
'pure'
:通过删除最终 CSS 中未使用的本地类名和值来实现死代码消除。仍然执行局部作用域和 @value
注入。
'icss'
:编译成 low-level 可互操作的 CSS 格式,该格式提供在 CSS 和其他语言之间声明 :import
和 :export
依赖项的语法。它不执行任何作用域或 @value
注入。
'local'
模式是 CSS Modules 最常见的用法,在组件内启用模块化和局部作用域样式。其他模式可能在特定场景下被使用。
export default {
output: {
cssModules: {
mode: 'global',
你还可以传递一个函数给 cssModules.mode
,并根据资源路径、query 或 fragment 确定 mode。这允许你为不同的文件使用不同的 mode。
例如,对 .module.css
文件使用局部作用域,对其他文件使用全局样式:
export default {
output: {
cssModules: {
mode: (resourcePath) => {
if (/\.module\.css$/.test(resourcePath)) {
return 'local';
return 'global';
cssModules.namedExport
类型: boolean
默认值: false
是否具名导出 class names。
export default {
output: {
cssModules: {
namedExport: true,
style.module.css
.foo {
color: blue;
namedExport: false
:
import styles from './style.module.css';
console.log(styles.foo);
namedExport: true
:
import { foo } from './style.module.css';
// or
import * as styles from './style.module.css';
console.log(foo);