📚 Documentation - 🔎 Demo
PhxLiveStorybook provides a storybook-like UI interface for your Phoenix LiveView components.
- Explore all your components, and showcase them with different stories.
- Browse your component's documentation, with their supported attributes.
- Learn how components behave by using an interactive playground.
PhxLiveStorybook is mounted in your application router and serves its UI at the mounting point of your choice.
It performs automatic discovery of your storybook content under a specified folder (:content_path
)
and then automatically generates a storybook navigation sidebar. Every module detected in your
content folder will be loaded and identified as a storybook entry.
Three kinds of entries are supported:
component
to describe your stateless function components or your live_components.page
to write & document UI guidelines, or whatever content you want.example
to show how your components can be used and mixed in real UI pages. (not available now)
Almost everything, from sidebar rendering to component preview, is performed at compile time.
To start using PhxLiveStorybook
in your phoenix application you will need to follow these steps:
- Add the
phx_live_storybook
dependency - Create your storybook backend module
- Add storybook access to your router
- Make your components assets available
- Configure your storybook
- Create some content
Add the following to your mix.exs and run mix deps.get:
def deps do
[
{:phx_live_storybook, "~> 0.3.0"}
]
end
Create a new module under your application lib folder:
# lib/my_app_web/storybook.ex
defmodule MyAppWeb.Storybook do
use PhxLiveStorybook, otp_app: :my_app
end
This backend module ensures the storybook gets recompiled as soon as you update your storybook content (see section 5.)
Once installed, update your router's configuration to forward requests to a PhxLiveStorybook
with a unique name of your choice:
# lib/my_app_web/router.ex
use MyAppWeb, :router
import PhxLiveStorybook.Router
...
scope "/" do
storybook_assets()
end
scope "/", PhxLiveStorybookSampleWeb do
pipe_through(:browser)
...
live_storybook("/storybook",
otp_app: :my_app,
backend_module: MyAppWeb.Storybook
)
end
Build a new CSS bundle dedicated to your live_view components: this bundle will be used both by your app and the storybook.
In this README, we use assets/css/my_components.css
as an example.
If your components require any hooks or custom uploaders, declare them as such in a new JS bundle:
// assets/js/my_components.js
import * as Hooks from "./hooks";
import * as Uploaders from "./uploaders";
(function () {
window.storybook = { Hooks, Uploaders };
})();
ℹ️ Learn more on this topic in the sandboxing guide.
In your configuration files, add the following:
# config/config.exs
config :my_app, MyAppWeb.Storybook,
content_path: Path.expand("../storybook", __DIR__),
css_path: "/assets/my_components.css",
js_path: "/assets/my_components.js"
Then you can start creating some content for your storybook. Storybook can contain different kinds of entries:
- component entries: to document and showcase your components across different stories (ie. variants)
- pages: to publish some UI guidelines, framework or whatever with regular HTML content.
- examples: to show how your components can be used and mixed in real UI pages.
As of 0.3.0
, only component and page entries are available.
Entries are described as Elixir scripts (.exs
) created under your :content_path
folder.
Feel free to organize them in sub-folders, as the hierarchy will be respected in your storybook
sidebar.
Here is an example of a stateless (function) component entry:
# storybook/components/button.exs
defmodule MyAppWeb.Storybook.Components.Button do
alias MyAppWeb.Components.Button
# :live_component or :page are also available
use PhxLiveStorybook.Entry, :component
def function, do: &Button.button/1
def description, do: "A simple generic button."
def stories do [
%Story{
id: :default,
attributes: %{
label: "A button"
}
},
%Story{
id: :green_button,
attributes: %{
label: "Still a button",
color: :green
}
}
]
end
end
ℹ️ Learn more on components in the components guide.
Of all config settings, only the :content_path
key is mandatory.
# config/config.exs
config :my_app, MyAppWeb.Storybook,
# Path to your storybook entries (required).
content_path: Path.expand("../storybook", __DIR__),
# Path to your components stylesheet.
css_path: "/assets/my_components.css",
# Path to your JS asset, which will be loaded just before PhxLiveStorybook's own
# JS. It's mainly intended to define your LiveView Hooks in `window.storybook.Hooks`.
js_path: "/assets/my_components.js",
# Custom storybook title. Default is "Live Storybook".
title: "My Live Storybook",
# Folder settings.
# Each folder is designated by its relative path from the storybook mounting point.
# For each folder you can:
# - make it open by default in the sidebar, with `open: true`.
# - give it a custom name in the sidebar
# - give it a custom icon in the sidebar, with a FontAwesome 6+ CSS class.
folders: [
"/": [icon: "fas fa-banana"],
"/components": [icon: "far fa-toolbox", open: true],
"components/live": [icon: "fal fa-bolt", name: "Live!!!"]
]
# Theme settings.
# Each theme must have a name, and an optional dropdown_class.
# When set, a dropdown is displayed in storybook header to let the user pick a theme.
# The dropdown_class is used to render the theme in the dropdown and identify which current
# theme is active.
#
# The chosen theme key will be passed as an assign to all components.
# ex: <.component theme={:colorful}/>
#
# The chosen theme class will also be added to the `.lsb-sandbox` container.
# ex: <div class="lsb-sandbox theme-colorful">...</div>
#
# If no theme has been selected or if no theme is present in the URL the first one is enabled.
themes: [
default: [name: "Default"],
colorful: [name: "Colorful", dropdown_class: "text-pink-400"]
]
ℹ️ Learn more on theming components in the theming guide.
MIT License. Copyright (c) 2022 Christian Blavier