FEATURED · 精选文章

如何在 Next.js 项目中用 nextjs-vite 框架安装 Storybook 并跑通开发模式

发布时间 / 2026/9/13 5:27:30
来源 / 创域科博编辑部
栏目 / 资讯中心
如何在 Next.js 项目中用 nextjs-vite 框架安装 Storybook 并跑通开发模式 如何在 Next.js 项目中用 nextjs-vite 框架安装 Storybook 并跑通开发模式【免费下载链接】storybookStorybook is the industry standard workshop for building, documenting, and testing UI components in isolation项目地址: https://gitcode.com/GitHub_Trending/st/storybook你有一个已经跑起来的 Next.js 应用现在希望用 Storybook 在隔离环境中开发、预览和测试 UI 组件。官方推荐的 Next.js 框架是nextjs-vite对应包storybook/nextjs-vite它用 Vite 作为构建器相比 Webpack 版storybook/nextjs构建更快且完整支持 Vitest 测试 等测试功能。这篇文章覆盖从版本要求、安装到启动开发服务器并确认运行结果的完整路径。版本要求按 Next.js (Vite) 框架文档使用该框架的硬性要求是Next.js ≥ 15Vite ≥ 5安装总览文档 还列出了运行 Storybook CLI 的环境要求Node.js 20、npm 10、pnpm 9、Yarn 4。如果你的 Next.js 项目尚未使用 Vite需要先确认项目里已安装 Vite 5 及以上版本。选择框架nextjs-vite 还是 nextjs在动手之前先明确一点这决定安装命令如何走nextjs-vite是官方推荐选项构建更快、HMR 更快且无需 Babel 或复杂的 Webpack 配置如果你的项目已有自定义 WebpackwebpackFinal或 Babel 配置且你不想把它们迁移到 Vite应选 Webpack 版的nextjs。Storybook CLI 在安装时会检查项目依赖并自动检测项目类型除非项目里存在自定义 Webpack 或 Babel 配置否则默认安装nextjs-vite框架存在自定义配置时CLI 会停下来询问你选择哪个框架。执行安装在 Next.js 项目的根目录运行npm create storybooklatest其他包管理器的等价命令pnpm create storybooklatestyarn create storybook安装过程会依次弹出交互式提示按实际情况选择即可New to Storybook?选 Yes 会进入一个交互式向导并生成示例 story 供学习有经验的话可以跳过得到一个最小化安装。What configuration should we install?两个选项Recommended包含组件开发、文档、测试、无障碍检查功能Minimal只装组件开发必需的部分。也可以跳过交互直接用--features参数手动指定功能例如npm create storybooklatest --features docs test a11y安装完成后该命令会对本地项目做以下变更安装所需依赖配置好运行和构建 Storybook 的脚本添加默认 Storybook 配置.storybook目录加入一些样板 story开启匿名遥测可查阅遥测文档了解如何退出。启动开发模式并验证结果安装成功后在同一个项目根目录运行npm run storybookpnpm 用pnpm run storybookYarn 用yarn storybook。这条命令会启动内置开发服务器终端输出访问地址并自动在新浏览器标签页打开 Storybook 的欢迎界面。开发模式跑通的判断依据是能看到类似文档中的欢迎界面界面上的关键内容一组指向配置和自定义选项的链接若干示例 story对应安装时生成的样板 story如果你跳过了 onboarding 向导且示例 story 还在可以在 Storybook URL 后追加?path/onboarding重新打开向导。看到界面并能在示例 story 中正常切换说明nextjs-vite框架的开发模式已经跑通。接下来可以按 writing stories 文档 开始写组件 story或参考 writing docs、running tests 继续深入。可选分支手动安装 nextjs-vite 框架如果不走交互式 CLI也可以手动安装框架文档的迁移章节中同样给出这一路径npm install --save-dev storybook/nextjs-vite然后在.storybook/main.js或.storybook/main.ts中把framework属性指向该包例如 TS 配置import type { StorybookConfig } from storybook/nextjs-vite; const config: StorybookConfig { framework: storybook/nextjs-vite, }; export default config;这条路径适合从其他框架如storybook/nextjs迁移或已有 Storybook 配置的项目。注意迁移自 Webpack 配置时webpackFinal中的自定义逻辑需要改写到viteFinal直接.md导入还需要加 Vite 的?raw后缀——这些细节在框架文档的迁移小节有说明。排查与限制安装或启动遇到问题时对照文档给出的处理方式CLI 没有检测到 Next.js 项目用--type显式指定项目类型。允许的值中 Next.js 对应nextjsnpm create storybooklatest --type nextjs想强制指定包管理器给安装命令追加--package-manager标志例如npm create storybooklatest --package-managernpm。空目录初始化问题在一个只有package.json的目录里初始化 Vite 系框架时Yarn Modern 可能因 peer 依赖处理导致问题解决办法是先用包管理器手动安装 Vite再运行 Storybook 初始化命令。avif 图片报错如果构建时报You are importing avif images, but you dont have sharp installed按文档在项目中安装sharpnpm install sharp/yarn add sharp/pnpm add sharp均可。下一步开发模式跑通之后生产构建用另一条脚本npm run build-storybook产物输出到配置的outputDir默认是storybook-static。边界说明本文只覆盖 Next.js 项目使用nextjs-vite框架的安装与开发模式如果你决定保留 Webpack 5 方案请改用storybook/nextjs框架文档两条路径的配置项如webpackFinal与viteFinal不通用。【免费下载链接】storybookStorybook is the industry standard workshop for building, documenting, and testing UI components in isolation项目地址: https://gitcode.com/GitHub_Trending/st/storybook创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
RELATED — 相关阅读

相关资讯

LATEST — 最新资讯

最新发布

TODAY — 本日精选

新闻

WEEKLY — 本周精选

新闻

MONTHLY — 本月精选

新闻