defmodule MvWeb.CoreComponents do @moduledoc """ Provides core UI components. At first glance, this module may seem daunting, but its goal is to provide core building blocks for your application, such as tables, forms, and inputs. The components consist mostly of markup and are well-documented with doc strings and declarative assigns. You may customize and style them in any way you want, based on your application growth and needs. The foundation for styling is Tailwind CSS, a utility-first CSS framework, augmented with daisyUI, a Tailwind CSS plugin that provides UI components and themes. Here are useful references: * [daisyUI](https://daisyui.com/docs/intro/) - a good place to get started and see the available components. * [Tailwind CSS](https://tailwindcss.com) - the foundational framework we build on. You will use it for layout, sizing, flexbox, grid, and spacing. * [Heroicons](https://heroicons.com) - see `icon/1` for usage. * [Phoenix.Component](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html) - the component system used by Phoenix. Some components, such as `<.link>` and `<.form>`, are defined there. """ use Phoenix.Component use Gettext, backend: MvWeb.Gettext alias Phoenix.LiveView.JS @doc """ Renders flash notices. ## Examples <.flash kind={:info} flash={@flash} /> <.flash kind={:info} phx-mounted={show("#flash")}>Welcome Back! """ attr :id, :string, doc: "the optional id of flash container" attr :flash, :map, default: %{}, doc: "the map of flash messages to display" attr :title, :string, default: nil attr :kind, :atom, values: [:info, :error, :success, :warning], doc: "used for styling and flash lookup" attr :rest, :global, doc: "the arbitrary HTML attributes to add to the flash container" slot :inner_block, doc: "the optional inner block that renders the flash message" def flash(assigns) do assigns = assign_new(assigns, :id, fn -> "flash-#{assigns.kind}" end) ~H"""
hide("##{@id}")} role="alert" class="pointer-events-auto" {@rest} >
<.icon :if={@kind == :info} name="hero-information-circle" class="size-5 shrink-0" /> <.icon :if={@kind == :error} name="hero-exclamation-circle" class="size-5 shrink-0" /> <.icon :if={@kind == :success} name="hero-check-circle" class="size-5 shrink-0" /> <.icon :if={@kind == :warning} name="hero-information-circle" class="size-5 shrink-0" />

{@title}

{msg}

""" end @doc """ Renders a button with navigation support. ## Variants (Design Guidelines §5.2) - primary (main CTA) - secondary (supporting) - neutral (cancel/back) - ghost (low emphasis; table/toolbars) - outline (alternative CTA) - danger (destructive) - link (inline; rare) - icon (icon-only) ## Sizes - sm, md (default), lg ## Examples <.button>Send! <.button phx-click="go" variant="primary">Send! <.button navigate={~p"/"} variant="secondary">Home <.button variant="ghost" size="sm">Edit <.button disabled={true}>Disabled """ attr :rest, :global, include: ~w(href navigate patch method data-testid) attr :variant, :string, values: ~w(primary secondary neutral ghost outline danger link icon), default: "primary" attr :size, :string, values: ~w(sm md lg), default: "md" attr :disabled, :boolean, default: false, doc: "Whether the button is disabled" slot :inner_block, required: true def button(assigns) do rest = assigns.rest variant = assigns[:variant] || "primary" size = assigns[:size] || "md" variant_classes = %{ "primary" => "btn-primary", "secondary" => "btn-secondary", "neutral" => "btn-neutral", "ghost" => "btn-ghost", "outline" => "btn-outline", "danger" => "btn-error", "link" => "btn-link", "icon" => "btn-ghost btn-square" } size_classes = %{ "sm" => "btn-sm", "md" => "", "lg" => "btn-lg" } base_class = Map.fetch!(variant_classes, variant) size_class = size_classes[size] btn_class = [base_class, size_class] |> Enum.reject(&(&1 == "")) |> Enum.join(" ") assigns = assign(assigns, :btn_class, btn_class) if rest[:href] || rest[:navigate] || rest[:patch] do link_class = if assigns[:disabled], do: ["btn", btn_class, "btn-disabled"], else: ["btn", btn_class] link_attrs = if assigns[:disabled] do rest |> Map.drop([:href, :navigate, :patch]) |> Map.merge(%{tabindex: "-1", "aria-disabled": "true"}) else rest end assigns = assigns |> assign(:link_class, link_class) |> assign(:link_attrs, link_attrs) ~H""" <.link class={@link_class} {@link_attrs}> {render_slot(@inner_block)} """ else ~H""" """ end end @doc """ Wraps content with a DaisyUI tooltip. Use for icon-only actions, truncated content, or status badges that need explanation (Design Guidelines §8.2). ## Examples <.tooltip content={gettext("Edit")}> <.button variant="icon" size="sm"><.icon name="hero-pencil" /> <.tooltip content={@full_name} position="top"> {@full_name} """ attr :content, :string, required: true, doc: "Tooltip text (data-tip)" attr :position, :string, values: ~w(top bottom left right), default: "bottom" attr :wrap_class, :string, default: nil, doc: "Additional classes for the wrapper" slot :inner_block, required: true def tooltip(assigns) do position_class = "tooltip tooltip-#{assigns.position}" wrap_class = [position_class, assigns.wrap_class] |> Enum.reject(&is_nil/1) |> Enum.join(" ") assigns = assign(assigns, :wrap_class, wrap_class) ~H"""
{render_slot(@inner_block)}
""" end @doc """ Renders a dropdown menu. ## Examples <.dropdown_menu items={@items} open={@open} phx_target={@myself} /> When using custom content (e.g., forms), use the inner_block slot: <.dropdown_menu button_label="Export" icon="hero-arrow-down-tray" open={@open} phx_target={@myself}>
  • ...
  • """ attr :id, :string, default: "dropdown-menu" attr :items, :list, default: [], doc: "List of %{label: string, value: any} maps" attr :button_label, :string, default: "Dropdown" attr :icon, :string, default: nil attr :checkboxes, :boolean, default: false attr :selected, :map, default: %{} attr :open, :boolean, default: false, doc: "Whether the dropdown is open" attr :show_select_buttons, :boolean, default: false, doc: "Show select all/none buttons" attr :phx_target, :any, required: true, doc: "The LiveView/LiveComponent target for events" attr :menu_class, :string, default: nil, doc: "Additional CSS classes for the menu" attr :menu_width, :string, default: "w-64", doc: "Width class for the menu (default: w-64)" attr :button_class, :string, default: nil, doc: "Additional CSS classes for the button (e.g., btn-secondary)" attr :menu_align, :string, default: "right", doc: "Menu alignment: 'left' or 'right' (default: right)" attr :testid, :string, default: "dropdown-menu", doc: "data-testid for the dropdown container" attr :button_testid, :string, default: "dropdown-button", doc: "data-testid for the button" attr :menu_testid, :string, default: nil, doc: "data-testid for the menu (defaults to testid + '-menu')" slot :inner_block, doc: "Custom content for the dropdown menu (e.g., forms)" def dropdown_menu(assigns) do menu_testid = assigns.menu_testid || "#{assigns.testid}-menu" assigns = assign(assigns, :menu_testid, menu_testid) ~H"""
    """ end @doc """ Renders a section in with a border similar to cards. ## Examples <.form_section title={gettext("Personal Data")}>

    input

    """ attr :title, :string, required: true slot :inner_block, required: true def form_section(assigns) do ~H"""

    {@title}

    {render_slot(@inner_block)}
    """ end @doc """ Renders an input with label and error messages. A `Phoenix.HTML.FormField` may be passed as argument, which is used to retrieve the input name, id, and values. Otherwise all attributes may be passed explicitly. ## Types This function accepts all HTML input types, considering that: * You may also set `type="select"` to render a ` {@label}* <.error :for={msg <- @errors}>{msg} """ end def input(%{type: "select"} = assigns) do assigns = ensure_aria_required_for_input(assigns) ~H"""
    <.error :for={msg <- @errors}>{msg}
    """ end def input(%{type: "textarea"} = assigns) do assigns = ensure_aria_required_for_input(assigns) ~H"""
    <.error :for={msg <- @errors}>{msg}
    """ end # All other inputs text, datetime-local, url, password, etc. are handled here... def input(assigns) do assigns = ensure_aria_required_for_input(assigns) ~H"""
    <.error :for={msg <- @errors}>{msg}
    """ end # WCAG 2.1: set aria-required when required is true so screen readers announce required state defp ensure_aria_required_for_input(assigns) do rest = assigns.rest || %{} rest = if rest[:required], do: Map.put(rest, :aria_required, "true"), else: rest assign(assigns, :rest, rest) end # Helper used by inputs to generate form errors defp error(assigns) do ~H"""

    <.icon name="hero-exclamation-circle" class="size-5" /> {render_slot(@inner_block)}

    """ end @doc """ Renders a header with title. """ attr :class, :string, default: nil slot :inner_block, required: true slot :subtitle slot :actions def header(assigns) do ~H"""

    {render_slot(@inner_block)}

    {render_slot(@subtitle)}

    {render_slot(@actions)}
    """ end @doc ~S""" Renders a table with generic styling. When `row_click` is set, clicking a row (or a data cell) triggers the handler. Rows with `row_click` get a subtle hover and focus-within outline (theme-friendly ring). When `selected_row_id` is set and matches a row's id (via `row_value_id` or `row_item.(row).id`), that row gets a stronger selected outline (ring-primary) for accessibility (not color-only). The action column has no phx-click on its ``, so action buttons do not trigger row navigation. For interactive elements inside other columns (e.g. checkboxes, buttons), use `Phoenix.LiveView.JS.stop_propagation()` in the element's phx-click so the row click is not fired. ## Examples <.table id="users" rows={@users}> <:col :let={user} label="id">{user.id} <:col :let={user} label="username">{user.username} <.table id="members" rows={@members} row_click={fn m -> JS.navigate(~p"/members/#{m}") end} selected_row_id={@selected_member_id}> <:col :let={m} label="Name">{m.name} """ attr :id, :string, required: true attr :rows, :list, required: true attr :row_id, :any, default: nil, doc: "the function for generating the row id" attr :row_click, :any, default: nil, doc: "the function for handling phx-click on each row" attr :selected_row_id, :any, default: nil, doc: "when set, the row whose id equals this value gets selected styling (single row, e.g. from URL)" attr :row_selected?, :any, default: nil, doc: "optional; function (row_item) -> boolean to mark multiple rows as selected (e.g. checkbox selection); overrides selected_row_id when set" attr :row_tooltip, :string, default: nil, doc: "optional; when row_click is set, tooltip text for the row (e.g. gettext(\"Click to view\")). Shown as title on hover and as sr-only for screen readers." attr :row_value_id, :any, default: nil, doc: "optional; function (row) -> id for comparing with selected_row_id; defaults to row_item.(row).id" attr :row_item, :any, default: &Function.identity/1, doc: "the function for mapping each row before calling the :col and :action slots" attr :dynamic_cols, :list, default: [], doc: "list of dynamic column definitions with :custom_field and :render functions" attr :sort_field, :any, default: nil, doc: "current sort field" attr :sort_order, :atom, default: nil, doc: "current sort order" attr :sticky_header, :boolean, default: false, doc: "when true, thead th get lg:sticky lg:top-0 bg-base-100 z-10 for use inside a scroll container on desktop" slot :col, required: true do attr :label, :string attr :class, :string attr :col_click, :any, doc: "optional column-specific click handler that overrides row_click" attr :sort_field, :any, doc: "optional; when equal to table sort_field, aria-sort is set on this th" end slot :action, doc: "the slot for showing user actions in the last table column" def table(assigns) do assigns = with %{rows: %Phoenix.LiveView.LiveStream{}} <- assigns do assign(assigns, row_id: assigns.row_id || fn {id, _item} -> id end) end # Function to get the row's value id for selected_row_id comparison (no extra DB reads) row_value_id_fn = assigns[:row_value_id] || fn row -> assigns.row_item.(row).id end assigns = assign(assigns, :row_value_id_fn, row_value_id_fn) ~H"""
    {col[:label]} <.live_component module={MvWeb.Components.SortHeaderComponent} id={:"sort_custom_field_#{dyn_col[:custom_field].id}"} field={"custom_field_#{dyn_col[:custom_field].id}"} label={dyn_col[:custom_field].name} sort_field={@sort_field} sort_order={@sort_order} /> {gettext("Actions")}
    <%= if col_idx == 0 && @row_click && @row_tooltip do %> {@row_tooltip} <% end %> {render_slot(col, @row_item.(row))} {if dyn_col[:render] do rendered = dyn_col[:render].(@row_item.(row)) if rendered == "" do "" else rendered end else "" end}
    <%= for action <- @action do %> {render_slot(action, @row_item.(row))} <% end %>
    """ end # Returns true if the row is selected (via row_selected?/1 or selected_row_id match). defp table_row_selected?(assigns, row) do item = assigns.row_item.(row) if assigns[:row_selected?] do assigns.row_selected?.(item) else assigns[:selected_row_id] != nil and assigns.row_value_id_fn.(row) == assigns.selected_row_id end end # Returns CSS classes for table row: hover/focus-within outline when row_click is set, # and stronger selected outline when selected (WCAG: not color-only). # Hover/focus-within are omitted for the selected row so the selected ring stays visible. defp table_row_tr_class(row_click, selected?) do has_row_click? = not is_nil(row_click) base = [] base = if has_row_click? and not selected?, do: base ++ [ "hover:ring-2", "hover:ring-inset", "hover:ring-base-content/10", "focus-within:ring-2", "focus-within:ring-inset", "focus-within:ring-base-content/10" ], else: base base = if selected?, do: base ++ ["ring-2", "ring-inset", "ring-primary"], else: base Enum.join(base, " ") end defp table_th_aria_sort(col, sort_field, sort_order) do col_sort = Map.get(col, :sort_field) if not is_nil(col_sort) and col_sort == sort_field and sort_order in [:asc, :desc] do if sort_order == :asc, do: "ascending", else: "descending" else nil end end # Combines column class with optional sticky header classes (desktop only; theme-friendly bg). defp table_th_class(col, sticky_header) do base = Map.get(col, :class) sticky = if sticky_header, do: "lg:sticky lg:top-0 bg-base-100 z-10", else: nil [base, sticky] |> Enum.filter(& &1) |> Enum.join(" ") end defp table_th_sticky_class(true), do: "lg:sticky lg:top-0 bg-base-100 z-10" defp table_th_sticky_class(_), do: nil @doc """ Renders a data list. ## Examples <.list> <:item title="Title">{@post.title} <:item title="Views">{@post.views} """ slot :item, required: true do attr :title, :string, required: true end def list(assigns) do ~H""" """ end @doc """ Renders a [Heroicon](https://heroicons.com). Heroicons come in three styles – outline, solid, and mini. By default, the outline style is used, but solid and mini may be applied by using the `-solid` and `-mini` suffix. You can customize the size and colors of the icons by setting width, height, and background color classes. Icons are extracted from the `deps/heroicons` directory and bundled within your compiled app.css by the plugin in `assets/vendor/heroicons.js`. ## Examples <.icon name="hero-x-mark" /> <.icon name="hero-arrow-path" class="ml-1 size-3 motion-safe:animate-spin" /> """ attr :name, :string, required: true attr :class, :string, default: "size-4" attr :rest, :global, include: ~w(aria-hidden) def icon(%{name: "hero-" <> _} = assigns) do ~H""" """ end ## JS Commands def show(js \\ %JS{}, selector) do JS.show(js, to: selector, time: 300, transition: {"transition-all ease-out duration-300", "opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95", "opacity-100 translate-y-0 sm:scale-100"} ) end def hide(js \\ %JS{}, selector) do JS.hide(js, to: selector, time: 200, transition: {"transition-all ease-in duration-200", "opacity-100 translate-y-0 sm:scale-100", "opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"} ) end @doc """ Translates an error message using gettext. """ def translate_error({msg, opts}) do # When using gettext, we typically pass the strings we want # to translate as a static argument: # # # Translate the number of files with plural rules # dngettext("errors", "1 file", "%{count} files", count) # # However the error messages in our forms and APIs are generated # dynamically, so we need to translate them by calling Gettext # with our gettext backend as first argument. Translations are # available in the errors.po file (as we use the "errors" domain). if count = opts[:count] do Gettext.dngettext(MvWeb.Gettext, "errors", msg, msg, count, opts) else Gettext.dgettext(MvWeb.Gettext, "errors", msg, opts) end end @doc """ Translates the errors for a field from a keyword list of errors. """ def translate_errors(errors, field) when is_list(errors) do for {^field, {msg, opts}} <- errors, do: translate_error({msg, opts}) end @doc """ Renders a list of items with name and value pairs. ## Examples <.generic_list items={[ {item.name, item.value}, {other.name, other.value} ]} /> """ attr :items, :list, required: true, doc: "List of {name, value} tuples" def generic_list(assigns) do ~H"""
    {name}
    {value}
    """ end end