# phoenix_storybook v1.1.0 - Table of Contents

> A pluggable storybook for your Phoenix components.

## GUIDES

- [Color modes](color_modes.md)
- [Component stories](components.md)
- [Custom Icons](icons.md)
- [Sandboxing components](sandboxing.md)
- [Manual setup](setup.md)
- [Visual Regression Testing](testing.md)
- [Theming components](theming.md)

## Modules

- [PhoenixStorybook](PhoenixStorybook.md): 
- [PhoenixStorybook.BackendBehaviour](PhoenixStorybook.BackendBehaviour.md): Behaviour implemented by your backend module.

- [PhoenixStorybook.Components.Icon](PhoenixStorybook.Components.Icon.md): Unified interface for rendering FontAwesome, HeroIcons, and local icons in Phoenix Storybook.
Supports multiple icon styles and customization through CSS classes.
Main function user_icon/1 handles all providers, with individual provider functions also available.

- [PhoenixStorybook.ErrorView](PhoenixStorybook.ErrorView.md)
- [PhoenixStorybook.Guides](PhoenixStorybook.Guides.md): This module is meant to be used from generated `welcome.story.exs` page.
It renders HTML markup from markdown guides located in the guides/folder.
- [PhoenixStorybook.Index](PhoenixStorybook.Index.md): An index is an optional file you can create in every folder of your storybook content tree to
improve rendering of the storybook sidebar.
- [PhoenixStorybook.Rendering.CodeRenderer](PhoenixStorybook.Rendering.CodeRenderer.md): Responsible for rendering your components code snippet, for a given
`PhoenixStorybook.Variation`.
- [PhoenixStorybook.Rendering.ComponentRenderer](PhoenixStorybook.Rendering.ComponentRenderer.md): Responsible for rendering your function & live components.

- [PhoenixStorybook.Rendering.MarkdownRenderer](PhoenixStorybook.Rendering.MarkdownRenderer.md): Responsible for rendering Markdown to HTML.
- [PhoenixStorybook.Rendering.RenderingContext](PhoenixStorybook.Rendering.RenderingContext.md): A struct holding all data needed by `ComponentRenderer` and `CodeRenderer` to render story
variations.

- [PhoenixStorybook.Router](PhoenixStorybook.Router.md): Provides LiveView routing for storybook.

- [PhoenixStorybook.Stories.Attr](PhoenixStorybook.Stories.Attr.md): An attr is one of your component attributes. Its structure mimics the LiveView 0.18.0 declarative
assigns.
- [PhoenixStorybook.Stories.Doc](PhoenixStorybook.Stories.Doc.md): Functions to fetch component documentation and render it at HTML.

- [PhoenixStorybook.Stories.Slot](PhoenixStorybook.Stories.Slot.md): A slot is one of your component slots. Its structure mimics the LiveView 0.18.0 declarative
assigns.
- [PhoenixStorybook.Stories.Variation](PhoenixStorybook.Stories.Variation.md): A variation captures the rendered state of a UI component. Developers write multiple variations
per component that describe all the “interesting” states a component can support.
- [PhoenixStorybook.Stories.VariationGroup](PhoenixStorybook.Stories.VariationGroup.md): A variation group is a set of similar variations that will be rendered together in a single
preview <pre> block.
- [PhoenixStorybook.Story](PhoenixStorybook.Story.md): A story designates any kind of content in your storybook. For now only following kinds of stories
are supported `:component`, `:live_component`, and `:page`.
- [PhoenixStorybook.Story.ComponentBehaviour](PhoenixStorybook.Story.ComponentBehaviour.md): Behaviour implemented by any component story

- [PhoenixStorybook.Story.ExampleBehaviour](PhoenixStorybook.Story.ExampleBehaviour.md): Behaviour implemented by any example story

- [PhoenixStorybook.Story.LiveComponentBehaviour](PhoenixStorybook.Story.LiveComponentBehaviour.md): Behaviour implemented by any live component story

- [PhoenixStorybook.Story.PageBehaviour](PhoenixStorybook.Story.PageBehaviour.md): Behaviour implemented by any page story

- [PhoenixStorybook.StoryLive](PhoenixStorybook.StoryLive.md)

## Mix Tasks

- [mix dev.storybook](Mix.Tasks.Dev.Storybook.md): Make sure your storybook local dependency has all its assets packaged in priv.
- [mix phx.gen.storybook](Mix.Tasks.Phx.Gen.Storybook.md): Generates a Storybook and provides setup instructions.