https://github.com/Kampfkarren/hoarcekat

A Storybook-like plugin that makes it easy to preview individual UI elements. Especially useful with Roact.
https://github.com/Kampfkarren/hoarcekat

Last synced: about 1 month ago
JSON representation

A Storybook-like plugin that makes it easy to preview individual UI elements. Especially useful with Roact.

• Host: GitHub
• URL: https://github.com/Kampfkarren/hoarcekat
• Owner: Kampfkarren
• License: other
• Created: 2020-01-22T13:14:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-20T11:20:25.000Z (8 months ago)
• Last Synced: 2024-11-30T01:23:51.748Z (about 2 months ago)
• Language: Lua
• Size: 96.7 KB
• Stars: 125
• Watchers: 4
• Forks: 24
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-react-lua - **Repository**
• awesome-react-lua - **Repository**

README

        
Hoarcekat


## What is it?

Hoarcekat is a [Storybook-like](https://storybook.js.org/) plugin that makes it easy to preview individual UI elements.

Developers write "stories" that explain how their UI should be previewed. It runs without any knowledge of the rest of your application, meaning you can use it to easily create and preview your UI as isolated components. Because of this, it is especially useful when using [Roact](https://roblox.github.io/roact/), though Roact is not required.

## How do I write a story?

Stories are ModuleScripts whose name ends with `.story`. These ModuleScripts return a function that takes an Instance (the preview frame) that then returns a destructor function, which cleans up the instance of anything the component put in.

It's much simpler to understand when you look at [an example story](https://github.com/Kampfkarren/hoarcekat/blob/master/examples/Counter.story.lua).

## How do I download it?

Method 1:

You can download the plugin [on the Roblox marketplace](https://www.roblox.com/library/4621580428/Hoarcekat).

Method 2:

You can download the latest version in the [GitHub releases](https://github.com/Kampfkarren/hoarcekat/releases). From here, go to the "Plugins Folder" found under the "Plugins" tab in Roblox Studio, and put the `.rbxmx` in there.

## Why the name?

Roblox engineers have been working on their own Storybook-like plugin for a long time named "Horsecat". However, due to problems with which the solutions are outside their control, it has not been made available to the public yet. Hoarcekat is meant to hold over until the official Horsecat is unveiled. Thus, the name is just an intentionally botched spelling.