Giter VIP home page Giter VIP logo

widgetbook's Introduction

Discord style: very good analysis GitHub Workflow Status GitHub Workflow Status

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!

Packages

The widgetbook repository contains of the Widgetbook packages which are located at /widgetbook/packages/.

The following packages exist:

Package Pub
widgetbook Pub Version
widgetbook_annotation Pub Version
widgetbook_generator Pub Version
widgetbook_models Pub Version

Examples

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

Example for Widgetbook with annotation and generator

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

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

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 or contacting us on discord.

widgetbook's People

Contributors

jenshor avatar joshpetit avatar lucasjosefiak avatar westito avatar heavybeard avatar mvolpato avatar scotts2017 avatar castrors avatar apackin avatar br1anchen avatar felangel avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.