Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ookami-kb/storybook_flutter
A storybook for Flutter widgets.
https://github.com/ookami-kb/storybook_flutter
dart dart2 flutter flutter-package storybook
Last synced: about 2 months ago
JSON representation
A storybook for Flutter widgets.
- Host: GitHub
- URL: https://github.com/ookami-kb/storybook_flutter
- Owner: ookami-kb
- License: mit
- Created: 2020-04-16T20:07:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T14:38:58.000Z (5 months ago)
- Last Synced: 2024-07-09T01:24:12.667Z (2 months ago)
- Topics: dart, dart2, flutter, flutter-package, storybook
- Language: Dart
- Homepage: https://pub.dev/packages/storybook_flutter
- Size: 18.9 MB
- Stars: 282
- Watchers: 5
- Forks: 61
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/storybook_flutter)
[](https://github.com/invertase/melos)
# Storybook Flutter
A cross-platform storybook for showcasing widgets. It should work at all
platforms supported by Flutter.
- [Demo version](https://ookami-kb.github.io/storybook_flutter/)
## Getting Started
```dart
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) =>
Storybook(
stories: [
Story(
name: 'Screens/Counter',
description: 'Demo Counter app with about dialog.',
builder: (context) => CounterPage(
title: context.knobs.text(label: 'Title', initial: 'Counter'),
enabled: context.knobs.boolean(label: 'Enabled', initial: true),
),
),
Story(
name: 'Widgets/Text',
description: 'Simple text widget.',
builder: (context) => const Center(child: Text('Simple text')),
),
],
);
}
```
## Customization
By default, each story is wrapped into `MaterialApp`.
You can override this behavior by providing either `wrapperBuilder` to the
`Storybook`. You can either use one of the default ones
(`materialWrapper`/`cupertinoWrapper`) or provide a fully custom wrapper. In the
latest case, make sure to use the `child` widget that will contain the story.
## Plugins
Almost all the functionality is provided by plugins. Even contents and
knobs are plugins (although they are first-party plugins).
Plugins documentation is TBD, but you can take a look at the existing
first-party plugins: `ContentsPlugin`, `DeviceFramePlugin`, `KnobsPlugin`,
`ThemModePlugin`.
## Golden tests
You can automatically test your stories by using `storybook_flutter_test` package:
1. Add it to `dev_dependencies`:
```yml
dev_dependencies:
storybook_flutter_test: any
```
2. Create test file, e.g. `storybook_test.dart`.
3. Add the following content there:
```dart
void main() => testStorybook(
storybook,
layouts: [
(
device: Devices.ios.iPhone13,
orientation: Orientation.portrait,
isFrameVisible: true,
),
(
device: Devices.ios.iPadPro11Inches,
orientation: Orientation.landscape,
isFrameVisible: true,
),
(
device: Devices.android.samsungGalaxyA50,
orientation: Orientation.portrait,
isFrameVisible: true,
),
],
);
```
4. Generate golden images by running `flutter test --update-goldens --tags=storybook`.
## Features and bugs
Please file feature requests and bugs at the [issue tracker][tracker].
[tracker]: https://github.com/ookami-kb/storybook_flutter/issues