Current section

Files

Jump to
corex lib components accordion.ex
Raw

lib/components/accordion.ex

defmodule Corex.Accordion do
@moduledoc ~S'''
Phoenix implementation of [Zag.js Accordion](https://zagjs.com/components/react/accordion).
## Examples
<!-- tabs-open -->
### List
You must use `Corex.Accordion.Item` struct for items.
The value for each item is optional, useful for controlled mode and API to identify the item.
You can specify disabled for each item
```heex
<.accordion
class="accordion"
items={[
%Corex.Accordion.Item{
trigger: "Lorem ipsum dolor sit amet",
content: "Consectetur adipiscing elit. Sed sodales ullamcorper tristique."
},
%Corex.Accordion.Item{
trigger: "Duis dictum gravida odio ac pharetra?",
content: "Nullam eget vestibulum ligula, at interdum tellus."
},
%Corex.Accordion.Item{
trigger: "Donec condimentum ex mi",
content: "Congue molestie ipsum gravida a. Sed ac eros luctus."
}
]}
/>
```
### List Custom
Similar to List but render a custom item slot that will be used for all items
Use `{item.meta.trigger}` and `{item.meta.content}` to render the trigger and content for each item
This example assumes the import of `.icon` from `Core Components`
```heex
<.accordion
class="accordion"
items={[
%Corex.Accordion.Item{
value: "lorem",
trigger: "Lorem ipsum dolor sit amet",
content: "Consectetur adipiscing elit. Sed sodales ullamcorper tristique.",
meta: %{
indicator: "hero-chevron-right",
}
},
%Corex.Accordion.Item{
trigger: "Duis dictum gravida odio ac pharetra?",
content: "Nullam eget vestibulum ligula, at interdum tellus.",
meta: %{
indicator: "hero-chevron-right",
}
},
%Corex.Accordion.Item{
value: "donec",
trigger: "Donec condimentum ex mi",
content: "Congue molestie ipsum gravida a. Sed ac eros luctus.",
disabled: true,
meta: %{
indicator: "hero-chevron-right",
}
}
]}
>
<:item :let={item}>
<.accordion_trigger item={item}>
{item.data.trigger}
<:indicator>
<.icon name={item.data.meta.indicator} />
</:indicator>
</.accordion_trigger>
<.accordion_content item={item}>
{item.data.content}
</.accordion_content>
</:item>
</.accordion>
```
### Custom
Render a custom item slot per accordion item manually
Use let={item} to get the item data and pass it to the `accordion_trigger/1` and `accordion_content/1` components
The trigger component takes an optional `:indicator` slot to render the indicator ico
This example assumes the import of `.icon` from `Core Components`
```heex
<.accordion id="my-accordion" value={["duis"]} class="accordion">
<:item :let={item} value="lorem" disabled>
<.accordion_trigger item={item}>
Lorem ipsum dolor sit amet
<:indicator>
<.icon name="hero-chevron-right" />
</:indicator>
</.accordion_trigger>
<.accordion_content item={item}">
Consectetur adipiscing elit. Sed sodales ullamcorper tristique. Proin quis risus feugiat tellus iaculis fringilla.
</.accordion_content>
</:item>
<:item :let={item} value="duis">
<.accordion_trigger item={item}>
Duis dictum gravida odio ac pharetra?
<:indicator>
<.icon name="hero-chevron-right" />
</:indicator>
</.accordion_trigger>
<.accordion_content item={item}>
Nullam eget vestibulum ligula, at interdum tellus. Quisque feugiat, dui ut fermentum sodales, lectus metus dignissim ex.
</.accordion_content>
</:item>
</.accordion>
```
### Controlled
Render an accordion controlled by the server.
You must use the `on_value_change` event to update the value on the server and pass the value as a list of strings
The event will receive the value as a map with the key `value` and the id of the accordion
```elixir
defmodule MyAppWeb.AccordionLive do
use MyAppWeb, :live_view
def mount(_params, _session, socket) do
{:ok, assign(socket, :value, ["lorem"])}
end
def handle_event("on_value_change", %{"value" => value}, socket) do
{:noreply, assign(socket, :value, value)}
end
def render(assigns) do
~H"""
<.accordion value={@value} on_value_change="on_value_change" class="accordion">
<:item :let={item} value="lorem">
<.accordion_trigger item={item}>
Lorem ipsum dolor sit amet
</.accordion_trigger>
<.accordion_content item={item}>
Consectetur adipiscing elit. Sed sodales ullamcorper tristique. Proin quis risus feugiat tellus iaculis fringilla.
</.accordion_content>
</:item>
<:item :let={item} value="duis">
<.accordion_trigger item={item}>
Duis dictum gravida odio ac pharetra?
</.accordion_trigger>
<.accordion_content item={item}>
Nullam eget vestibulum ligula, at interdum tellus. Quisque feugiat, dui ut fermentum sodales, lectus metus dignissim ex.
</.accordion_content>
</:item>
</.accordion>
"""
end
end
```
### Async
When the initial props are not available on mount, you can use the `assign_async` function to assign the props asynchronously
You can use the optional `accordion_skeleton/1` to render a loading or error state
```elixir
defmodule MyAppWeb.AccordionAsyncLive do
use MyAppWeb, :live_view
def mount(_params, _session, socket) do
socket =
socket
|> assign_async(:accordion, fn ->
Process.sleep(1000)
items = [
%Corex.Accordion.Item{
value: "lorem",
trigger: "Lorem ipsum dolor sit amet",
content: "Consectetur adipiscing elit. Sed sodales ullamcorper tristique.",
disabled: true
},
%Corex.Accordion.Item{
value: "duis",
trigger: "Duis dictum gravida odio ac pharetra?",
content: "Nullam eget vestibulum ligula, at interdum tellus."
},
%Corex.Accordion.Item{
value: "donec",
trigger: "Donec condimentum ex mi",
content: "Congue molestie ipsum gravida a. Sed ac eros luctus."
}
]
{:ok,
%{
accordion: %{
items: items,
value: ["duis", "donec"]
}
}}
end)
{:ok, socket}
end
def render(assigns) do
~H"""
<Layouts.app flash={@flash}>
<div class="layout__row">
<h1>Accordion</h1>
<h2>Async</h2>
</div>
<.async_result :let={accordion} assign={@accordion}>
<:loading>
<.accordion_skeleton count={3} class="accordion" />
</:loading>
<:failed>
there was an error loading the accordion
</:failed>
<.accordion
id="async-accordion"
class="accordion"
items={accordion.items}
value={accordion.value}
/>
</.async_result>
</Layouts.app>
"""
end
end
```
<!-- tabs-close -->
## API Control
***Client-side***
```heex
<button phx-click={Corex.Accordion.set_value("my-accordion", ["item-1"])}>
Open Item 1
</button>
```
***Server-side***
```elixir
def handle_event("open_item", _, socket) do
{:noreply, Corex.Accordion.set_value(socket, "my-accordion", ["item-1"])}
end
```
## Styling
Use data attributes to target elements:
```css
[data-scope="accordion"][data-part="root"] {}
[data-scope="accordion"][data-part="item"] {}
[data-scope="accordion"][data-part="item-trigger"] {}
[data-scope="accordion"][data-part="item-content"] {}
[data-scope="accordion"][data-part="item-indicator"] {}
```
'''
@doc type: :component
use Phoenix.Component
alias Corex.Accordion.Anatomy.{Props, Root, Item}
alias Corex.Accordion.Connect
import Corex.Helpers, only: [validate_value!: 1]
@doc """
Renders an accordion component.
You can use either:
- The `:item` slot for manual item definition with full control
- The `:items` attribute for programmatic item generation from a list of `%Corex.Accordion.Item{}` structs
When using `:items`, each item MUST be a `%Corex.Accordion.Item{}` struct with:
- `:value` (required) - unique identifier for the item
- `:trigger` (required) - content for the trigger button
- `:content` (optional, default: "") - content for the accordion panel
- `:disabled` (optional, default: false) - whether the item is disabled
"""
attr(:id, :string,
required: false,
doc: "The id of the accordion, useful for API to identify the accordion"
)
attr(:items, :list,
default: nil,
doc: "The items of the accordion, must be a list of %Corex.Accordion.Item{} structs"
)
attr(:value, :list,
default: [],
doc: "The initial value or the controlled value of the accordion, must be a list of strings"
)
attr(:controlled, :boolean,
default: false,
doc:
"Whether the accordion is controlled. Only in LiveView, the on_value_change event is required"
)
attr(:collapsible, :boolean, default: true, doc: "Whether the accordion is collapsible")
attr(:disabled, :boolean, default: false, doc: "Whether the accordion is disabled")
attr(:multiple, :boolean,
default: true,
doc: "Whether the accordion allows multiple items to be selected"
)
attr(:orientation, :string,
default: "vertical",
values: ["horizontal", "vertical"],
doc: "The orientation of the accordion"
)
attr(:dir, :string,
default: "ltr",
values: ["ltr", "rtl"],
doc: "The direction of the accordion"
)
attr(:on_value_change, :string,
default: nil,
doc: "The server event name when the value change"
)
attr(:on_value_change_client, :string,
default: nil,
doc: "The client event name when the value change"
)
attr(:on_focus_change, :string,
default: nil,
doc: "The server event name when the focus change"
)
attr(:on_focus_change_client, :string,
default: nil,
doc: "The client event name when the focus change"
)
attr(:rest, :global)
slot :item, required: false do
attr(:value, :string,
doc: "The value of the item, useful in controlled mode and for API to identify the item"
)
attr(:disabled, :boolean, doc: "Whether the item is disabled")
end
def accordion(assigns) do
assigns =
assigns
|> assign_new(:id, fn -> "accordion-#{System.unique_integer([:positive])}" end)
|> validate_items()
~H"""
<div id={@id} phx-hook="Accordion" {@rest}
{Connect.props(%Props{
id: @id,
controlled: @controlled,
value: @value,
collapsible: @collapsible,
disabled: @disabled,
multiple: @multiple,
orientation: @orientation,
dir: @dir,
on_value_change: @on_value_change,
on_value_change_client: @on_value_change_client,
on_focus_change: @on_focus_change,
on_focus_change_client: @on_focus_change_client
})}>
<div {Connect.root(%Root{id: @id, orientation: @orientation, dir: @dir, changed: if(@__changed__, do: true, else: false)})}>
<div :if={@items && @item == []} :for={{item_entry, index} <- Enum.with_index(@items || [])} {Connect.item(%Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: item_entry.value || "item-#{index}",
disabled: item_entry.disabled,
values: @value,
orientation: @orientation,
dir: @dir,
disabled_root: @disabled
})}>
<.accordion_trigger item={%Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: item_entry.value || "item-#{index}",
disabled: item_entry.disabled,
values: @value,
orientation: @orientation,
dir: @dir,
disabled_root: @disabled,
data: %{
trigger: item_entry.trigger,
content: item_entry.content,
meta: item_entry.meta
}
}}>
{item_entry.trigger}
</.accordion_trigger>
<.accordion_content item={%Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: item_entry.value || "item-#{index}",
disabled: item_entry.disabled,
values: @value,
orientation: @orientation,
dir: @dir,
disabled_root: @disabled,
data: %{
trigger: item_entry.trigger,
content: item_entry.content,
meta: item_entry.meta
}
}}>
{item_entry.content}
</.accordion_content>
</div>
<div :if={@items && @item != []} :for={{item_entry, index} <- Enum.with_index(@items || [])} {Connect.item(%Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: item_entry.value || "item-#{index}",
disabled: item_entry.disabled,
values: @value,
orientation: @orientation,
dir: @dir,
disabled_root: @disabled,
data: %{
trigger: item_entry.trigger,
content: item_entry.content,
meta: item_entry.meta
}
})}>
<div :for={item_slot <- @item || []}>
<%= render_slot(item_slot, %Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: item_entry.value || "item-#{index}",
disabled: Map.get(item_entry, :disabled, false),
values: @value,
orientation: @orientation,
dir: @dir,
disabled_root: @disabled,
data: %{
trigger: item_entry.trigger,
content: item_entry.content,
meta: item_entry.meta
}
})
%>
</div>
</div>
<div :if={is_nil(@items)} :for={{item_entry, index} <- Enum.with_index(@item)}
{Connect.item(%Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: Map.get(item_entry, :value, "item-#{index}"),
disabled: Map.get(item_entry, :disabled, false),
values: @value, orientation: @orientation,
dir: @dir,
disabled_root: @disabled})}>
<%= render_slot(item_entry, %Item{
id: @id,
changed: if(@__changed__, do: true, else: false),
value: Map.get(item_entry, :value, "item-#{index}"),
disabled: Map.get(item_entry, :disabled, false),
values: @value,
orientation: @orientation,
dir: @dir,
disabled_root: @disabled})
%>
</div>
</div>
</div>
"""
end
defp validate_items(%{items: nil} = assigns), do: assigns
defp validate_items(%{items: items} = assigns) when is_list(items) do
Enum.each(items, fn item ->
unless is_struct(item, Corex.Accordion.Item) do
raise ArgumentError, """
Invalid item in :items attribute. Expected %Corex.Accordion.Item{} struct, got: #{inspect(item)}
Please use the Corex.Accordion.Item struct:
%Corex.Accordion.Item{
value: "unique-id",
trigger: "Trigger text",
content: "Content text",
disabled: false # optional, defaults to false
}
"""
end
end)
assigns
end
defp validate_items(assigns), do: assigns
@doc type: :component
@doc """
Renders the accordion trigger button. Includes optional `:indicator` slot.
"""
attr(:item, :map, required: true)
slot(:inner_block, required: true)
slot(:indicator, required: false)
def accordion_trigger(assigns) do
~H"""
<h3>
<button {Connect.trigger(@item)}>
<span data-scope="accordion" data-part="item-text">
{render_slot(@inner_block)}
</span>
<span :if={@indicator} {Connect.indicator(@item)}>
{render_slot(@indicator)}
</span>
</button>
</h3>
"""
end
@doc type: :component
@doc """
Renders the accordion content area.
"""
attr(:item, :map, required: true)
slot(:inner_block, required: true)
def accordion_content(assigns) do
~H"""
<div {Connect.content(@item)} >
{render_slot(@inner_block)}
</div>
"""
end
@doc type: :component
@doc """
Renders a loading skeleton for the accordion component.
"""
attr(:count, :integer, default: 3)
attr(:rest, :global)
slot(:trigger)
slot(:indicator)
slot(:content)
def accordion_skeleton(assigns) do
~H"""
<div {@rest}>
<div data-scope="accordion" data-part="root" data-loading>
<div :for={item <- 1..@count} data-scope="accordion" data-part="item">
<div data-scope="accordion" data-part="item-trigger">
<span data-scope="accordion" data-part="item-text">
{render_slot(@trigger)}
</span>
<span data-scope="accordion" data-part="item-indicator">
{render_slot(@indicator)}
</span>
</div>
</div>
</div>
</div>
"""
end
@doc type: :api
@doc """
Sets the accordion value from client-side. Returns a `Phoenix.LiveView.JS` command.
## Examples
<button phx-click={Corex.Accordion.set_value("my-accordion", ["item-1"])}>
Open Item 1
</button>
"""
def set_value(accordion_id, value) when is_binary(accordion_id) do
Phoenix.LiveView.JS.dispatch("phx:accordion:set-value",
to: "##{accordion_id}",
detail: %{value: validate_value!(value)},
bubbles: false
)
end
@doc type: :api
@doc """
Sets the accordion value from server-side. Pushes a LiveView event.
## Examples
def handle_event("open_item", _params, socket) do
socket = Corex.Accordion.set_value(socket, "my-accordion", ["item-1"])
{:noreply, socket}
end
"""
def set_value(socket, accordion_id, value)
when is_struct(socket, Phoenix.LiveView.Socket) and is_binary(accordion_id) do
Phoenix.LiveView.push_event(socket, "accordion_set_value", %{
accordion_id: accordion_id,
value: validate_value!(value)
})
end
end