defmodule LivebookWeb.LiveHelpers do
use Phoenix.Component
alias Phoenix.LiveView.JS
@doc """
Wraps the given content in a modal dialog.
## Example
<.modal id="edit-modal" patch={...}>
<.live_component module={MyComponent} />
"""
def modal(assigns) do
assigns =
assigns
|> assign_new(:show, fn -> false end)
|> assign_new(:patch, fn -> nil end)
|> assign_new(:navigate, fn -> nil end)
|> assign_new(:class, fn -> "" end)
|> assign(:attrs, assigns_to_attributes(assigns, [:id, :show, :patch, :navigate, :class]))
~H"""
<%= if @patch do %>
<%= live_patch "", to: @patch, class: "hidden", id: "#{@id}-return" %>
<% end %>
<%= if @navigate do %>
<%= live_redirect "", to: @navigate, class: "hidden", id: "#{@id}-return" %>
<% end %>
<%= render_slot(@inner_block) %>
"""
end
@doc """
Shows a modal rendered with `modal/1`.
"""
def show_modal(js \\ %JS{}, id) do
js
|> JS.show(
to: "##{id}",
transition: {"ease-out duration-200", "opacity-0", "opacity-100"}
)
end
@doc """
Hides a modal rendered with `modal/1`.
"""
def hide_modal(js \\ %JS{}, id) do
js
|> JS.hide(
to: "##{id}",
transition: {"ease-in duration-200", "opacity-100", "opacity-0"}
)
|> JS.dispatch("click", to: "##{id}-return")
end
@doc """
Renders the confirmation modal for `with_confirm/3`.
"""
def confirm_modal(assigns) do
assigns = assign_new(assigns, :id, fn -> "confirm-modal" end)
~H"""
<.modal id={@id} class="w-full max-w-xl" phx-hook="ConfirmModal" data-js-show={show_modal(@id)}>
"""
end
@doc """
Shows a confirmation modal before executing the given JS action.
The modal template must already be on the page, see `confirm_modal/1`.
## Options
* `:title` - title of the confirmation modal. Defaults to `"Are you sure?"`
* `:description` - content of the confirmation modal. Required
* `:confirm_text` - text of the confirm button. Defaults to `"Yes"`
* `:confirm_icon` - icon in the confirm button. Optional
* `:danger` - whether the action is destructive or regular. Defaults to `true`
* `:html` - whether the `:description` is a raw HTML. Defaults to `false`
* `:opt_out_id` - enables the "Don't show this message again"
checkbox. Once checked by the user, the confirmation with this
id is never shown again. Optional
## Examples
"""
def with_confirm(js \\ %JS{}, on_confirm, opts) do
opts =
Keyword.validate!(
opts,
[
:confirm_icon,
:description,
:opt_out_id,
title: "Are you sure?",
confirm_text: "Yes",
danger: true,
html: false
]
)
JS.dispatch(js, "lb:confirm_request",
detail: %{
on_confirm: Jason.encode!(on_confirm.ops),
title: opts[:title],
description: Keyword.fetch!(opts, :description),
confirm_text: opts[:confirm_text],
confirm_icon: opts[:confirm_icon],
danger: opts[:danger],
html: opts[:html],
opt_out_id: opts[:opt_out_id]
}
)
end
@doc """
Renders a text content skeleton.
## Options
* `:empty` - if the source is empty. Defauls to `false`
* `:bg_class` - the skeleton background color. Defaults to `"bg-gray-200"`
"""
def content_skeleton(assigns) do
assigns =
assigns
|> assign_new(:empty, fn -> false end)
|> assign_new(:bg_class, fn -> "bg-gray-200" end)
~H"""
<%= if @empty do %>
<% else %>
<% end %>
"""
end
@doc """
Renders [Remix](https://remixicon.com) icon.
## Examples
<.remix_icon icon="cpu-line" />
<.remix_icon icon="cpu-line" class="align-middle mr-1" />
"""
def remix_icon(assigns) do
assigns =
assigns
|> assign_new(:class, fn -> "" end)
|> assign(:attrs, assigns_to_attributes(assigns, [:icon, :class]))
~H"""
"""
end
@doc """
Renders a list of select input options with the given one selected.
## Examples
<.select
name="language"
selected={@language}
options={[en: "English", pl: "Polski", fr: "Français"]} />
"""
def select(assigns) do
~H"""
"""
end
@doc """
Renders a checkbox input styled as a switch.
Also, a hidden input with the same name is rendered
alongside the checkbox, so the submitted value is
always either `"true"` or `"false"`.
## Examples
<.switch_checkbox
name="likes_cats"
label="I very much like cats"
checked={@likes_cats} />
"""
def switch_checkbox(assigns) do
assigns =
assigns
|> assign_new(:label, fn -> nil end)
|> assign_new(:disabled, fn -> false end)
|> assign_new(:class, fn -> "" end)
|> assign(
:attrs,
assigns_to_attributes(assigns, [:label, :name, :checked, :disabled, :class])
)
~H"""
<%= if @label do %>
<%= @label %>
<% end %>
"""
end
@doc """
Renders a choice button that is either active or not.
## Examples
<.choice_button active={@tab == "my_tab"} phx-click="set_my_tab">
My tab
"""
def choice_button(assigns) do
assigns =
assigns
|> assign_new(:class, fn -> "" end)
|> assign_new(:disabled, fn -> assigns.active end)
|> assign(:attrs, assigns_to_attributes(assigns, [:active, :class, :disabled]))
~H"""
"""
end
@doc """
Renders a highlighted code snippet.
## Examples
<.code_preview
source_id="my-snippet"
language="elixir"
source="System.version()" />
"""
def code_preview(assigns) do
~H"""
<%= @source %>
"""
end
@doc """
Renders text with a tiny label.
## Examples
<.labeled_text label="Name">Sherlock Holmes
"""
def labeled_text(assigns) do
assigns = assign_new(assigns, :one_line, fn -> false end)
~H"""
<%= @label %>
<%= render_slot(@inner_block) %>
"""
end
@doc """
Renders a wrapper around password input with an added visibility
toggle button.
The toggle switches the input's type between `password` and `text`.
## Examples
<.with_password_toggle id="secret-password-toggle">
"""
def with_password_toggle(assigns) do
~H"""
<%= render_slot(@inner_block) %>
"""
end
@doc """
Renders a popup menu that shows up on toggle click.
## Assigns
* `:id` - unique HTML id
* `:disabled` - whether the menu is active. Defaults to `false`
* `:position` - which side of the clickable the menu menu should
be attached to, either `"left"` or `"right"`. Defaults to `"right"`
* `:secondary_click` - whether secondary click (usually right mouse click)
should open the menu. Defaults to `false`
## Examples
<.menu id="my-menu">
<:toggle>
<:content>
"""
def menu(assigns) do
assigns =
assigns
|> assign_new(:disabled, fn -> false end)
|> assign_new(:position, fn -> "bottom-right" end)
|> assign_new(:secondary_click, fn -> false end)
~H"""
<%= render_slot(@toggle) %>
"""
end
defp menu_content_class("top-left"), do: "menu__content--top-left"
defp menu_content_class("top-right"), do: "menu__content--top-right"
defp menu_content_class("bottom-left"), do: "menu__content--bottom-left"
defp menu_content_class("bottom-right"), do: "menu__content--bottom-right"
@doc """
A menu item that shows a submenu on hover.
This component should be used within `menu/1` content.
## Example
<.submenu>
<:content>
"""
def submenu(assigns) do
~H"""
<%= render_slot(@inner_block) %>
"""
end
@doc """
Creates a live region with the given role.
## Examples
<.live_region role="alert" />
<.live_region role="status" />
"""
def live_region(assigns) do
~H"""
"""
end
@doc """
Sends a message to be read by the screen reader by changing the text content of the live region
"""
def sr_message(js \\ %JS{}, message) do
JS.dispatch(js, "lb:set_text", to: "#live-region", detail: %{value: message})
end
end