Skip to content

Using Storybook

Storybook is a tool for documenting and building UI components in isolation. Component documentation is organized into "stories" that show a variety of possible rendered states of a UI component.

Browsertrix component stories live in frontend/src/stories. Component attributes that are public properties (i.e. defined with Lit @property({ type: Type })) or documented in a TSDoc comment will automatically appear in stories through the Custom Elements Manifest file.

To develop using Storybook, run:

yarn storybook:watch

This will open Storybook in your default browser. Changes to Browsertrix components and stories wil automatically refresh the page.