首页
/ 解决Next.js项目在Storybook中使用next-usequerystate报错问题

解决Next.js项目在Storybook中使用next-usequerystate报错问题

2025-05-30 16:23:22作者:丁柯新Fawn

问题背景

在Next.js项目中使用next-usequerystate库时,如果通过Storybook运行包含该库的组件,可能会遇到"invariant expected app router to be mounted"错误。这个问题主要出现在同时使用Pages Router和Storybook的场景中。

错误原因分析

该问题的根源在于next-usequerystate库为了同时支持App Router和Pages Router,内部使用了next/navigation的导入方式。然而Storybook目前对这种混合使用模式的支持还不完善,特别是在Pages Router项目中尝试使用App Router相关功能时。

技术细节

next-usequerystate库的设计初衷是提供一个统一的API来兼容Next.js的两种路由系统。但在实现上,它依赖于next/navigation模块,这个模块在Pages Router环境下的兼容层并不完全稳定,导致在某些配置组合下会出现问题。

解决方案

目前可行的临时解决方案是在Storybook的配置中添加AppRouterContext的Provider装饰器:

import {
  AppRouterContext,
  type AppRouterInstance,
} from 'next/dist/shared/lib/app-router-context.shared-runtime';

const meta = {
  decorators: [
    (Story) => (
      <AppRouterContext.Provider value={{} as AppRouterInstance}>
        <Story />
      </AppRouterContext.Provider>
    ),
  ],
};

这个方案通过手动提供AppRouterContext来模拟App Router环境,使得next-usequerystate能够正常工作。

长期展望

Storybook团队正在积极解决Next.js路由兼容性问题,预计在未来的v8版本中会提供更完善的解决方案。开发者可以关注相关进展,在官方修复发布后升级依赖版本。

最佳实践建议

  1. 在Pages Router项目中,明确区分App Router和Pages Router的使用场景
  2. 保持next-usequerystate和Storybook等相关依赖的最新版本
  3. 对于关键业务组件,考虑编写独立的测试用例而不完全依赖Storybook
  4. 在团队内部文档中记录此类兼容性问题及解决方案

通过理解问题本质并应用上述解决方案,开发者可以顺利在Storybook中测试使用next-usequerystate的组件,同时为未来的兼容性改进做好准备。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K