Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

H-1: Support loading blocks in # Storybook #2278

Open
vilkinsons opened this issue Mar 24, 2023 · 0 comments
Open

H-1: Support loading blocks in # Storybook #2278

vilkinsons opened this issue Mar 24, 2023 · 0 comments
Labels
area/blocks Relates to first-party blocks (area) area/dx Improvements or additions to DX or docs priority/3 low Lower priority: nice-to-have type/eng > frontend Owned by the @frontend team

Comments

@vilkinsons
Copy link
Member

vilkinsons commented Mar 24, 2023

Context

We'd like to be able to load the contents of our blocks directory into the HASH Storybook instance (not to be confused with that recently set up in the Block Protocol repository):

There are a number of different ways we could probably go about making blocks accessible within Storybook, including through the use of the Þ Dock (aka. mock-block-dock, or "MBD") as a decorator, wrapped into a Block Protocol add-on for Storybook.

How a Þ Storybook add-on might work

Functionality

Flesh this out

We would create an add-on for Storybook.

We would use the Þ Dock as a decorator: https://storybook.js.org/docs/react/writing-stories/decorators

Location in monorepo

The code for the add-on would likely live within the blockprotocol repository's libs folder.

Publishing the add-on

Once functional, the Storybook add-on could be published to npm and the add-on itself even listed in the public Storybook integrations library. The add-on could then be imported for use within both the # and Þ Storybook instances.

Follow-ups

Unblocks H-3 and H-5.

@vilkinsons vilkinsons changed the title Support loading blocks in # Storybook [H-1] Support loading blocks in # Storybook Mar 24, 2023
@vilkinsons vilkinsons added area: dx area/dx Improvements or additions to DX or docs type/eng > frontend Owned by the @frontend team and removed area: dx labels Mar 27, 2023
@vilkinsons vilkinsons added the priority/1 high High priority: current top priority label Mar 30, 2023
@vilkinsons vilkinsons added priority/2 medium Medium priority: needs to be done and removed priority/1 high High priority: current top priority labels Jul 2, 2023
@vilkinsons vilkinsons changed the title [H-1] Support loading blocks in # Storybook H-1: Support loading blocks in # Storybook Jul 6, 2023
@vilkinsons vilkinsons added the area/blocks Relates to first-party blocks (area) label Aug 10, 2023
@vilkinsons vilkinsons added priority/3 low Lower priority: nice-to-have and removed priority/2 medium Medium priority: needs to be done labels Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/blocks Relates to first-party blocks (area) area/dx Improvements or additions to DX or docs priority/3 low Lower priority: nice-to-have type/eng > frontend Owned by the @frontend team
Development

No branches or pull requests

1 participant