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

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强大的视口测试功能。