Widgetbook is the custom widget library specifically created for Flutter applications. Developers can manage all of their widgets in one place and see how they will appear on different devices as well as in different languages and themes.
Widgetbook Cloud is the collaboration platform for Flutter frontend teams. Developers can easily share their Widgetbook with designers, project managers, clients, and more to simplify review processes.
Get access to Widgetbook Cloud!
The widgetbook repository contains of the Widgetbook packages which are located at /widgetbook/packages/.
The following packages exist:
| Package | Pub |
|---|---|
| widgetbook | |
| widgetbook_annotation | |
| widgetbook_generator | |
| widgetbook_models |
All example apps are located at /widgetbook/examples/.
Example for package:widgetbook
Examples on how to use package:widgetbook are located at /widgetbook/examples/widgetbook_example/.
Examples on how to use package:widgetbook in combination with package:widgetbook_annotation and package:widgetbook_generator are located at /widgetbook/examples/widgetbook_annotation_example/.
You can run the example apps in VS Code by using the predefined launch configurations. The following configurations exist:
| Configuration | Description |
|---|---|
| Debug widgetbook_example | Starts the widgetbook for /widgetbook/examples/widgetbook_example/ as debug |
| Debug widgetbook_annotation_example | Starts the widgetbook for /widgetbook/examples/widgetbook_annotation_example/ as debug |
| Debug Example App | Starts the example app without Widgetbook. This is great to see what the actual app feels like and how it transforms into Widgetbook |
| Debug widgetbook_generator | Launches the generated code from package:widgetbook_generator. Run flutter pub run build_runner build before! This is great to develop package:widgetbook_generator. |
We love the open source flutter community!💙 If you'd like to contribute to one or all Widgetbook packages, feel free to open a pull-request at any time. To give new contributors exciting first challenges, we're labelling some easy-to-fix issues "good first issue".
If something does not feel right or if you have questions, feel free to contact us. You can do so by creating an issue or contacting us on discord.