解决 MUI 主题样式在设计系统包构建中无法正确加载的问题

冬强姑娘_2293

冬强姑娘_2293

2026-08-17

651人浏览

原创

解决 MUI 主题样式在设计系统包构建中无法正确加载的问题

本文详解如何修复使用 Rollup 构建 React 设计系统时,因 @mui/material/styles 模块解析失败导致的 ESM 导入错误,重点配置 Rollup 插件链与 TypeScript 编译选项以兼容 MUI 的模块规范。

本文详解如何修复使用 rollup 构建 react 设计系统时,因 `@mui/material/styles` 模块解析失败导致的 esm 导入错误,重点配置 rollup 插件链与 typescript 编译选项以兼容 mui 的模块规范。

在构建可复用的 React 设计系统包(如基于 Material UI)时,一个常见但棘手的问题是:组件导出正常,但主题相关模块(如 createTheme、ThemeProvider)在消费项目中报错——典型错误为:

Module not found: Error: Can't resolve '@mui/material/styles' ...
BREAKING CHANGE: The request failed to resolve only because it was resolved as fully specified.
Add the extension to the request.

该错误本质源于 ESM 严格解析规则 与 MUI v5.13+(尤其是其 ESM 构建产物)的交互问题:当 Rollup 打包后的 .js 文件被标记为 "type": "module"(或运行在原生 ESM 环境),Node.js 要求所有裸导入(bare imports)必须显式声明扩展名(如 .js),而 @mui/material/styles 是一个无扩展名的包入口,其内部依赖链可能未完全适配此约束。

✅ 核心解决方案:调整 Rollup 插件顺序与配置

关键在于确保 @rollup/plugin-node-resolve 在 @rollup/plugin-commonjs 之前 执行,并启用 exportConditions 显式支持 ESM 条件导出。同时,需将 @mui/* 相关包设为外部依赖(peer deps),避免重复打包引发路径错乱。

以下是经过验证的 rollup.config.js 配置要点(含注释说明):

import commonjs from "@rollup/plugin-commonjs";
import resolve from "@rollup/plugin-node-resolve";
import peerDepsExternal from "rollup-plugin-peer-deps-external";
import typescript from "@rollup/plugin-typescript";
import postcss from "rollup-plugin-postcss";
import url from "@rollup/plugin-url";
import svgr from "@svgr/rollup";
import dts from "rollup-plugin-dts";

import packageJson from "./package.json";

export default [
  {
    input: "./src/index.ts",
    output: [
      {
        file: packageJson.main,
        format: "cjs",
        sourcemap: true,
      },
      {
        file: packageJson.module,
        format: "esm",
        sourcemap: true,
      },
    ],
    plugins: [
      // ✅ 必须最先:将 peer dependencies(如 @mui/material)排除在 bundle 外
      peerDepsExternal(),
      // ✅ 关键:启用 ESM 条件解析,匹配 MUI 的 package.json exports 字段
      resolve({
        exportConditions: ["module", "import", "require"],
        extensions: [".js", ".jsx", ".ts", ".tsx"],
      }),
      // ✅ 其次:转换 CommonJS 模块(如某些 MUI 内部依赖)
      commonjs(),
      typescript({ tsconfig: "./tsconfig.json" }),
      postcss(),
      url(),
      svgr(),
    ],
  },
  // 类型声明文件单独生成
  {
    input: "./build/dts/index.d.ts",
    output: [{ file: "build/index.d.ts", format: "es" }],
    plugins: [dts()],
  },
];

? 为什么 resolve 必须在 commonjs 之前?
若 commonjs 先执行,它会尝试将 @mui/material/styles 当作 CJS 模块处理,但该路径实际指向一个 ESM 入口(如 index.js),导致解析失败。resolve 提前识别并正确解析其 ESM 条件导出后,commonjs 才能安全跳过它。

?️ TypeScript 配置强化(tsconfig.json)

确保 moduleResolution 和 module 与 Rollup 输出格式对齐,并启用严格的类型生成:

{
  "compilerOptions": {
    "target": "es2018",
    "lib": ["es2018", "dom", "dom.iterable"],
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "declaration": true,
    "declarationDir": "build/dts",
    "emitDeclarationOnly": true,
    "jsx": "react-jsx",
    "noEmit": false, // ⚠️ 注意:Rollup 负责编译,此处可设 false;若用 tsc 生成 .d.ts 则保留 true
    "outDir": "./build"
  },
  "include": ["src"],
  "exclude": ["node_modules", "build"]
}

? 重要注意事项

  • 不要重写 MUI 导入路径:如将 @mui/material/styles 改为 @mui/material/styles/index.js —— 这虽临时绕过错误,但破坏了语义化版本兼容性,且在不同环境(如 Vite、Webpack 5+)下行为不一致。
  • 验证 peerDependencies:确保 design-system 的 package.json 中明确声明:
    "peerDependencies": {
      "@mui/material": "^5.14.0",
      "@emotion/react": "^11.10.0",
      "@emotion/styled": "^11.10.0"
    }
  • 消费端需安装对应 peer deps:下游项目必须手动安装 @mui/material 等,否则即使构建通过,运行时仍会缺失样式注入逻辑。
  • CSS-in-JS 支持:rollup-plugin-postcss 需配置 inject: false(默认)并确保 @emotion/react 正确注入 ,否则主题样式不会生效。

✅ 验证是否成功

构建后检查 dist/esm/index.js 中对 @mui/material/styles 的引用是否保留为原始路径(未被重写),并在消费项目中执行:

// ✅ 正确用法(无需修改路径)
import { createTheme, ThemeProvider } from '@mui/material/styles';
import { DesignSystemButton } from 'design-system';

const theme = createTheme({ palette: { primary: { main: '#007bff' } } });

function App() {
  return (
    <themeprovider theme="{theme}"><designsystembutton>Click me</designsystembutton></themeprovider>
  );
}

若控制台无 Module not found 错误,且按钮渲染符合主题定义,则配置已生效。

通过上述 Rollup 插件协同与 TypeScript 精准配置,即可彻底解决 MUI 主题在设计系统包中的 ESM 加载异常,为多项目共享高质量 UI 奠定坚实基础。

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

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

下载

相关标签:

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

相关专题

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

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

2023.06.20

5426

5

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

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

2023.07.04

1329

3

js四舍五入
js四舍五入

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

2023.07.04

5364

6

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

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

2023.09.01

1020

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1956

5

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

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

2023.09.04

3765

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4933

6

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

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

2023.09.20

3240

5

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

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

2023.09.20

1048

7

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习