View Source PhxLiveStorybook.Entry (phx_live_storybook v0.1.0)

An entry designates any kind of content in your storybook. For now only two kinds of entries are supported: component and :live_component, but :page and :example will follow in later versions.

In order to populate your storybook, just create entry modules under your content path, and implement their required behaviour.

usage

Usage

component

Component

Implement your component as such. Confer to PhxLiveStorybook.Variation documentation for variations.

defmodule MyAppWeb.Storybook.MyComponent do
  use PhxLiveStorybook.Entry, :component

  # required
  def component, do: MyAppWeb.MyComponent

  # required
  def function, do: &MyAppWeb.MyComponent.my_component/1

  def description, do: "My component description"
  def icon, do: "fa fa-icon"

  # required
  def variations, do: []
end

live-component

Live Component

Very similar components, excepted the function/0 callback no longer required.

defmodule MyAppWeb.Storybook.MyLiveComponent do
  use PhxLiveStorybook.Entry, :live_component

  # required
  def component, do: MyAppWeb.MyLiveComponent

  def description, do: "My live component description"
  def icon, do: "fa fa-icon"

  # required
  def variations, do: []
end

Link to this section Summary

Link to this section Functions

Link to this macro

__using__(which)

View Source (macro)

Convenience helper for using the functions above.

Link to this function

component_behaviour(live)

View Source