API Reference phx_live_storybook v0.3.0

modules

Modules

PhxLiveStorybook provides a storybook-like UI interface for your Phoenix LiveView components.

An attr is one of your component attributes. Its structure mimics forthcoming LiveView 0.18.0 declarative assigns.

Behaviour implemented by your backend module.

An entry designates any kind of content in your storybook. For now only following kinds of entries are supported: component, :live_component, and :page.

Responsible for rendering your components code snippet, for a given PhxLiveStorybook.Story.

Responsible for rendering your function & live components, for a given PhxLiveStorybook.Story or PhxLiveStorybook.StoryGroup.

Provides LiveView routing for storybook.

A story captures the rendered state of a UI component. Developers write multiple stories per component that describe all the “interesting” states a component can support.

A story group is a set of similar stories that will be rendered together in a single preview <pre> block.