首页
/ Storybook 9 视口(viewport) API 重大变更解析

Storybook 9 视口(viewport) API 重大变更解析

2025-04-29 17:15:42作者:范靓好Udolf

Storybook 8.x版本对视口(viewport)功能进行了重大重构,引入了全新的API设计。本文将详细解析这一变更的技术细节,帮助开发者顺利过渡到Storybook 9的新API。

旧版视口配置回顾

在Storybook 8之前,开发者主要通过viewportStoryGlobals选项来配置视口参数。这种方式需要将视口设置作为全局变量(globals)的一部分进行管理,配置方式相对复杂且不够直观。

典型的旧版配置示例如下:

export const parameters = {
  viewport: {
    viewports: {
      mobile1: {
        name: 'Small mobile',
        styles: {
          width: '320px',
          height: '568px'
        }
      }
    }
  }
}

新版API设计理念

Storybook 9彻底重构了视口API,移除了viewportStoryGlobals选项,转而采用更加简洁直观的配置方式。这一变更基于以下设计考虑:

  1. 配置简化:减少不必要的中间层,直接通过options对象进行配置
  2. 一致性:与其他Storybook API保持一致的配置风格
  3. 可维护性:降低API的复杂度,便于长期维护

新版配置方式详解

新版API允许开发者直接在story的配置中定义视口参数:

export default {
  title: 'Example/Button',
  parameters: {
    viewport: {
      defaultViewport: 'mobile1',
      viewports: {
        mobile1: {
          name: 'Small mobile',
          styles: {
            width: '320px',
            height: '568px'
          }
        }
      }
    }
  }
}

主要变更点包括:

  • 移除了viewportStoryGlobals选项
  • 视口配置直接集成到常规参数系统中
  • 支持更灵活的视口定义方式

迁移指南

对于从旧版升级的项目,需要进行以下调整:

  1. 查找并替换:项目中所有使用viewportStoryGlobals的地方
  2. 配置转换:将原有全局视口配置转换为新版参数格式
  3. 测试验证:确保所有视口相关功能正常工作

建议的迁移步骤:

  1. 首先升级到Storybook 8.x最新版
  2. 逐步将视口配置转换为新版格式
  3. 最后升级到Storybook 9

最佳实践

基于新版API,推荐以下视口配置实践:

  1. 预设视口:利用Storybook提供的预设视口(如iPhone X、iPad等)
  2. 项目专属视口:为项目定义专属的视口集合
  3. 组件级视口:可以为特定组件定义专属视口
// 使用预设视口
import { INITIAL_VIEWPORTS } from '@storybook/addon-viewport';

export default {
  parameters: {
    viewport: {
      viewports: INITIAL_VIEWPORTS
    }
  }
}

总结

Storybook 9对视口API的重构是向更简洁、更一致的配置系统迈进的重要一步。虽然这一变更需要现有项目进行一定程度的迁移工作,但长远来看将显著提升配置的直观性和可维护性。开发者应尽快熟悉新版API,以便充分利用Storybook强大的视口测试功能。

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

项目优选

收起
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