https://github.com/widgetbook/widgetbook

Widgetbook is the custom widget library and collaboration platform for Flutter frontend teams.
https://github.com/widgetbook/widgetbook

dart flutter storybook

Last synced: 23 days ago
JSON representation

Widgetbook is the custom widget library and collaboration platform for Flutter frontend teams.

• Host: GitHub
• URL: https://github.com/widgetbook/widgetbook
• Owner: widgetbook
• Created: 2021-08-24T09:19:17.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T13:14:59.000Z (7 months ago)
• Last Synced: 2024-04-24T07:14:00.434Z (7 months ago)
• Topics: dart, flutter, storybook
• Language: Dart
• Homepage: https://widgetbook.io
• Size: 33.3 MB
• Stars: 670
• Watchers: 13
• Forks: 164
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        


[![Discord](https://img.shields.io/discord/879618555560218625?color=blue&style=flat-square)](https://discord.com/invite/zT4AMStAJA)

[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg?style=flat-square)](https://pub.dev/packages/very_good_analysis) 

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/widgetbook/widgetbook/widgetbook.yaml?branch=main)

# Open Source Package & Widgetbook Cloud

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!](https://www.widgetbook.io/)

# Packages

The widgetbook repository contains of the Widgetbook packages which are located at [/widgetbook/packages/](https://github.com/widgetbook/widgetbook/tree/main/packages).

The following packages exist:

| Package           | Pub |

| ----------------- | --------------------------------- |

| [widgetbook](https://github.com/widgetbook/widgetbook/tree/main/packages/widgetbook) | [![Pub Version](https://img.shields.io/pub/v/widgetbook?style=flat-square)](https://pub.dev/packages/widgetbook) | 

| [widgetbook_annotation](https://github.com/widgetbook/widgetbook/tree/main/packages/widgetbook_annotation) | [![Pub Version](https://img.shields.io/pub/v/widgetbook_annotation?style=flat-square)](https://pub.dev/packages/widgetbook_annotation)  | 

| [widgetbook_generator](https://github.com/widgetbook/widgetbook/tree/main/packages/widgetbook_generator) | [![Pub Version](https://img.shields.io/pub/v/widgetbook_generator?style=flat-square)](https://pub.dev/packages/widgetbook_generator) | 

# Examples

All example apps are located at [/widgetbook/examples/](https://github.com/widgetbook/widgetbook/tree/main/examples/).

## Running the examples in VS Code

You can run the example apps in VS Code by using the predefined launch configurations. The following configurations exist:

| Configuration | Description |

| ------------- | ----------- |

| Debug widgetbook_generator | Launches the generated code from [package:widgetbook_generator](https://github.com/widgetbook/widgetbook/tree/main/packages/widgetbook_generator). Run `flutter pub run build_runner build` before! This is great to develop [package:widgetbook_generator](https://github.com/widgetbook/widgetbook/tree/main/packages/widgetbook_generator). |

# Contributions

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".

# Questions or Issues? 

If something does not feel right or if you have questions, feel free to contact us. You can do so by [creating an issue](https://github.com/widgetbook/widgetbook/issues) or [contacting us on discord](https://discord.gg/zT4AMStAJA).