首页
/ 解决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的组件,同时为未来的兼容性改进做好准备。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8