Storybook项目中SVG组件导入问题的解决方案

问题背景

在React组件库开发过程中，开发者经常会使用Storybook作为组件展示和文档工具。当项目中同时使用Rollup作为打包工具时，可能会遇到一个常见问题：SVG文件无法作为React组件正确导入到Storybook环境中。

具体表现为：当尝试通过import { ReactComponent as SpinnerIcon } from './spinner.svg'这样的语法导入SVG时，Storybook会抛出错误提示"Element type is invalid: expected a string (for built-in components) or a class/function (for composite components) but got: undefined"。

问题根源分析

这个问题的本质在于Storybook和Rollup对SVG文件的处理方式不同：

1. Rollup配置：通常使用@svgr/rollup插件将SVG转换为React组件，这种配置在项目构建时工作正常
2. Storybook默认配置：Storybook使用Webpack作为打包工具，默认情况下没有配置SVGR转换器，导致无法识别ReactComponent导入语法

解决方案探索

方案一：自定义Webpack配置

最直接的解决方案是修改Storybook的Webpack配置，使其能够正确处理SVG文件：

1. 安装必要的依赖包：@svgr/webpack
2. 在Storybook配置文件中添加Webpack自定义配置
3. 移除默认的SVG文件加载器
4. 添加SVGR加载器专门处理SVG文件

这种方案虽然理论上可行，但在实际应用中可能会遇到配置复杂或与其他加载器冲突的问题。

方案二：使用专用插件

更简单可靠的解决方案是使用专门为Storybook设计的SVGR插件：

1. 安装@newhighsco/storybook-addon-svgr插件
2. 在Storybook配置的addons数组中添加该插件
3. 无需额外配置即可自动处理SVG组件导入

最佳实践建议

1. 统一构建环境：确保项目构建和Storybook环境对资源文件的处理方式一致
2. 优先使用专用插件：社区维护的专用插件通常经过充分测试，比自定义配置更可靠
3. 测试验证：在修改配置后，应在独立于Storybook的环境中测试SVG组件导入，以确认问题是Storybook特有的

实施步骤

1. 安装依赖：npm install --save-dev @newhighsco/storybook-addon-svgr
2. 修改Storybook配置文件(.storybook/main.js或.ts)：

   module.exports = {
     // 其他配置...
     addons: [
       // 其他插件...
       '@newhighsco/storybook-addon-svgr'
     ]
   }
   

3. 重启Storybook开发服务器

注意事项

1. 确保SVG文件本身是有效的XML格式
2. 如果SVG包含特殊属性或样式，可能需要额外配置
3. 在TypeScript项目中，可能需要添加类型声明文件

通过以上解决方案，开发者可以轻松地在Storybook环境中使用SVG作为React组件，保持开发体验的一致性，提高组件库的开发效率。