storybook_flutter
0.14.1, released 3 years ago by ookamikb.dev
A storybook for Flutter widgets to showcase and preview isolated components.
WASM-ready
What it does
Provides a live preview of isolated Flutter widgets to speed up development. Includes built-in plugins for contents, device frames, and knobs for interactive parameter tweaking.
AI-written summary of version 0.14.1, based on the package's README and metadata. Report an inaccuracy
Use it when
- You want to showcase and test widgets in isolation
- You want to allow designers or developers to tweak widget parameters using interactive knobs
- You need to run golden tests on your widget stories
Skip it when
- You are building a production backend or state management solution
- You do not need a component library viewer
Strengths
- Supports cross-platform targets
- Includes a rich plugin system (knobs, device frames, logging)
- Supports golden testing via a companion package
Weaknesses
- Plugins documentation is largely TBD in the current version
Setup
- Kind
- Flutter widgets
- Effort
- Low
- Code generation
- No
- Direct dependencies
- 6
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) =>
Storybook(
stories: [
Story(
name: 'Widgets/Text',
description: 'Simple text widget.',
builder: (context) => const Center(child: Text('Simple text')),
),
],
);
}Works with
Packages commonly used together with storybook_flutter: ones it builds on, ones built on it, and its own family.
- nestedstorybook_flutter depends on itWidget that flattens deeply nested widget trees into a list of children.
- recasestorybook_flutter depends on itChanges the case of input text to various conventions.
- providerstorybook_flutter depends on itA lightweight wrapper around InheritedWidget for state management
- device_framestorybook_flutter depends on itProvides mock device frames to preview Flutter UI on various device screens.
- pointer_interceptorstorybook_flutter depends on itA widget to prevent clicks from being swallowed by underlying HtmlElementViews on the web.