https://github.com/flipbook-labs/flipbook

Storybook plugin for Roblox UI
https://github.com/flipbook-labs/flipbook

plugin roact roblox storybook

Last synced: about 2 months ago
JSON representation

Storybook plugin for Roblox UI

• Host: GitHub
• URL: https://github.com/flipbook-labs/flipbook
• Owner: flipbook-labs
• License: mit
• Created: 2021-12-30T22:19:47.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T22:58:46.000Z (7 months ago)
• Last Synced: 2024-04-14T16:06:57.738Z (7 months ago)
• Topics: plugin, roact, roblox, storybook
• Language: Lua
• Homepage: https://flipbook-labs.github.io/flipbook/
• Size: 2.94 MB
• Stars: 88
• Watchers: 4
• Forks: 6
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-roblox - flipbook - Storybook plugin for previewing UI components. (Plugins)
• awesome-roblox - Flipbook
• awesome-roblox - Flipbook

README

        
#  flipbook

[![Install](https://img.shields.io/badge/install-Roblox%20Marketplace-informational)](https://www.roblox.com/library/8517129161)

[![Docs](https://img.shields.io/badge/learn-Documentation-brightgreen)](https://flipbook-labs.github.io/flipbook)

[![Discussion](https://img.shields.io/badge/discussion-DevForum-brightgreen)](https://devforum.roblox.com/t/flipbook-%E2%80%94-storybook-plugin-for-roblox-ui/2184387)

[![CI](https://github.com/flipbook-labs/flipbook/actions/workflows/ci.yml/badge.svg)](https://github.com/flipbook-labs/flipbook/actions/workflows/ci.yml)

flipbook is a storybook plugin that previews UI components in a sandboxed environment. With it you can isolate distinct parts of your game's UI to hammer out edge cases and complex states without having to run through the whole UI.

With native support for popular UI libraries like [Roact](https://github.com/roblox/roact), [Fusion](https://github.com/Elttob/Fusion), and [Roact 17](https://github.com/grilme99/CorePackages#roact17), no matter how you create UI you can write a story for it in flipbook

![Screenshot of flipbook showing off the ButtonWithControls story](docs/static/img/main-screenshot.png)

## Installation

You can install flipbook from the [Roblox marketplace](https://www.roblox.com/library/8517129161) or from the [GitHub releases](https://github.com/flipbook-labs/flipbook/releases) page.

## Documentation

Learn how to use flipbook on the [documentation site](https://flipbook-labs.github.io/flipbook/).

## Contributing

Before opening a pull request, check out our [contributing guide](https://flipbook-labs.github.io/flipbook/docs/contributing/) to learn how we develop the plugin.

## License

[MIT License](LICENSE)