Flutter插件playbook的使用_Playbook 是一个用于独立开发 UI 组件并自动拍摄快照的库。它受到 JavaScript 中的 Storybook 启发，用于前端 Web 开发

发布于 1周前 作者 ionicwang 最后一次编辑是 5天前 来自 Flutter

Flutter插件playbook的使用_Playbook 是一个用于独立开发 UI 组件并自动拍摄快照的库。它受到 JavaScript 中的 Storybook 启发，用于前端 Web 开发

Flutter插件playbook概述

Playbook 是一个用于独立开发 UI 组件并自动拍摄快照的库。它受到 JavaScript 中的 Storybook 启发，用于前端 Web 开发。

通过使用 Playbook，你可以生成独立的应用程序作为活生生的设计指南。这不仅允许你快速审查 UI，还可以通过将业务逻辑从组件中分离出来交付更健壮的设计。

此外，每个组件的快照可以通过单元测试自动生成，并且可以使用任意第三方工具进行视觉回归测试。

对于复杂的现代应用程序开发来说，敏感地捕捉 UI 变化并更快地改进它们非常重要。借助 Playbook，你无需为准备数据和手动测试花费大量时间和人力资源。

Playbook 组件

Playbook 组件以场景的形式唯一存储。一个场景描述了组件的布局方式。

Playbook(
  stories: [
    Story(
      'Home',
      scenarios: [
        Scenario(
          'CategoryHome',
          layout: ScenarioLayout.fill(),
          child: CategoryHome(userData: UserData.stub),
        ),
        Scenario(
          'LandmarkList',
          layout: ScenarioLayout.fill(),
          child: Scaffold(
            appBar: AppBar(),
            body: LandmarkList(userData: UserData.stub),
          ),
        ),
        Scenario(
          'Container red',
          layout: ScenarioLayout.fixed(100, 100),
          child: Container(color: Colors.red),
        ),
      ],
    ),
  ],
);

PlaybookUI

PlaybookUI 提供了浏览场景列表的用户界面。

PlaybookGallery

组件的可视化被列出并显示。在顶部屏幕上显示的内容实际上并没有进行布局，而是显示在运行时高效生成的快照。

PlaybookSnapshot

场景可以通过符合 TestTool 类型的实例进行测试。Snapshot 是其中之一，它可以生成所有场景的快照，并模拟给定设备的屏幕尺寸和安全区域。

Future<void> main() async {
  testWidgets('Take snapshots', (tester) async {
    await Playbook(
      stories: [
        barStory(),
        fooWidgetStory(),
        assetImageStory(),
        homePageStory(),
        scrollableStory(),
      ],
    ).run(
      Snapshot(
        devices: [SnapshotDevice.iPhoneSE2nd],
      ),
      (widget, device) {
        return MaterialApp(
          debugShowCheckedModeBanner: false,
          theme: ThemeData(
            fontFamily: 'Roboto',
            platform: device.platform,
          ),
          home: widget,
        );
      },
    );
  });
}

配置

可以在 pubspec.yaml 中配置字体文件的位置和快照输出目录路径。

playbook_snapshot:
  fonts:
    - family: Roboto
      fonts:
        - asset: assets/fonts/Roboto-Regular.ttf
  # 默认为 /snapshots
  snapshot_dir: iOS
  # 默认为空
  sub_dir: service

上述设置后，快照将保存在以下目录中。

/test/iOS/${DeviceName}/service/${StoryTitle}/${ScenarioTitle}.png

如果你想要动态更改路径，可以在 Snapshot 中使用 snapshotDir 和 subDir 参数。

PlaybookGenerator

支持从任何 .dart 文件生成故事和场景。

// some_story.dart

const storyTitle = 'Home';

@GenerateScenario(
  layout: ScenarioLayout.fill(),
)
Widget $CategoryHome() => CategoryHome(userData: UserData.stub);

@GenerateScenario(
  layout: ScenarioLayout.fill(),
)
Widget $LandmarkList() => Scaffold(
      appBar: AppBar(),
      body: LandmarkList(userData: UserData.stub),
    );

@GenerateScenario(
  title: 'Container red',
  layout: ScenarioLayout.fixed(100, 100),
)
Widget containerRed() => Container(color: Colors.red);

@GenerateScenario(
  title: 'Device pixel ratio',
  layout: ScenarioLayout.fixed(300, 300),
)
Widget devicePixelRatio(BuildContext context) =>
    Text('Device pixel ratio is ${MediaQuery.of(context).devicePixelRatio}');

你可以引用 Playbook 实例。

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Playbook Demo',
      theme: ThemeData.light(),
      home: PlaybookGallery(
        title: 'Sample app',
        playbook: playbook,
      ),
    );
  }
}

可以在 build.yaml 中设置 glob 查找资产和输出文件名。默认输入值为 lib/**.dart，输出值为 generated_playbook.dart。

targets:
  $default:
    builders:
      playbook_generator:stories:
        options:
          input: lib/**.dart
          output: generated_playbook.dart

更多关于Flutter插件playbook的使用_Playbook 是一个用于独立开发 UI 组件并自动拍摄快照的库。它受到 JavaScript 中的 Storybook 启发，用于前端 Web 开发的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter插件playbook的使用_Playbook 是一个用于独立开发 UI 组件并自动拍摄快照的库。它受到 JavaScript 中的 Storybook 启发，用于前端 Web 开发的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter中，如果playbook是一个假设的插件，并且它与策略、计划或数据展示相关，我们可以根据这些功能进行代码案例的编写。尽管我们无法获得插件的实际API文档，但我们可以通过常见的Flutter插件开发模式来推测和展示如何使用它。

以下是一个基于Flutter和Dart的假设代码案例，展示了如何使用一个名为playbook的插件来管理策略、计划或展示数据。请注意，这里的代码完全是基于假设的，实际使用时需要根据插件的真实API进行调整。

1. 添加依赖

首先，我们假设playbook插件已经在pub.dev上发布，并且我们可以通过在pubspec.yaml文件中添加依赖来使用它。

dependencies:
  flutter:
    sdk: flutter
  playbook: ^0.1.0  # 假设的版本号

2. 导入插件

在Dart文件中导入playbook插件。

import 'package:playbook/playbook.dart';

3. 初始化插件并设置策略/计划

假设playbook插件有一个方法来初始化并设置策略或计划。以下是一个简单的示例：

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Playbook Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: Text('Playbook Demo'),
        ),
        body: PlaybookDemo(),
      ),
    );
  }
}

class PlaybookDemo extends StatefulWidget {
  @override
  _PlaybookDemoState createState() => _PlaybookDemoState();
}

class _PlaybookDemoState extends State<PlaybookDemo> {
  late PlaybookClient playbookClient;

  @override
  void initState() {
    super.initState();
    // 初始化playbook插件
    playbookClient = PlaybookClient();

    // 设置策略或计划（假设有一个方法叫做setStrategy）
    // 这里的数据是假设的，实际使用时需要替换为真实的数据
    final strategyData = {
      'name': 'Strategy A',
      'description': 'This is a sample strategy.',
      'steps': [
        {'title': 'Step 1', 'details': 'Do something.'},
        {'title': 'Step 2', 'details': 'Do something else.'},
      ],
    };

    playbookClient.setStrategy(strategyData);
  }

  @override
  Widget build(BuildContext context) {
    return Center(
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: <Widget>[
          Text('Playbook Strategy Demo'),
          ElevatedButton(
            onPressed: () {
              // 假设有一个方法来展示策略
              playbookClient.showStrategy();
            },
            child: Text('Show Strategy'),
          ),
        ],
      ),
    );
  }
}

// 假设的PlaybookClient类（实际使用时需要根据插件API创建）
class PlaybookClient {
  // 假设的setStrategy方法（实际使用时需要根据插件API实现）
  void setStrategy(Map<String, dynamic> strategyData) {
    // 这里是假设的实现，实际使用时需要替换为插件提供的API
    print('Setting strategy: $strategyData');
  }

  // 假设的showStrategy方法（实际使用时需要根据插件API实现）
  void showStrategy() {
    // 这里是假设的实现，实际使用时需要替换为插件提供的展示策略的方法
    print('Showing strategy...');
    // 例如，可以弹出一个对话框来展示策略数据
    showDialog(
      context: /* 需要传入一个BuildContext实例，这里省略了具体实现 */,
      builder: (BuildContext context) {
        return AlertDialog(
          title: Text('Strategy Details'),
          content: Text('/* 这里可以展示strategyData的内容 */'),
          actions: <Widget>[
            TextButton(
              onPressed: () {
                Navigator.of(context).pop();
              },
              child: Text('Close'),
            ),
          ],
        );
      },
    );
  }
}

注意事项

  1. 插件API：上述代码是基于假设的API编写的。实际使用时，你需要查阅playbook插件的官方文档，了解如何正确初始化插件、设置策略/计划以及展示数据。

  2. BuildContext：在showDialog方法中，你需要传入一个BuildContext实例。在上面的代码中，这个实例被省略了，因为完整的实现需要依赖于你具体的Flutter应用结构。

  3. 错误处理：在实际应用中，你应该添加错误处理逻辑来捕获和处理可能发生的异常，例如网络错误、数据解析错误等。

  4. 数据格式：上述代码中的strategyData是一个假设的数据格式。你需要根据playbook插件的实际要求来构建和传递数据。

  5. UI设计：上述代码中的UI设计是非常基础的。在实际应用中，你可能需要设计更复杂的UI来展示策略/计划的数据。

回到顶部