defmodule Corex.PinInput do @moduledoc ~S''' Phoenix implementation of [Zag.js Pin Input](https://zagjs.com/components/react/pin-input). ## Examples ### Basic ```heex <.pin_input id="pin" count={4} class="pin-input"> <:label>Code ``` ## Styling Use data attributes to target elements: ```css [data-scope="pin-input"][data-part="root"] {} [data-scope="pin-input"][data-part="label"] {} [data-scope="pin-input"][data-part="control"] {} [data-scope="pin-input"][data-part="input"] {} ``` If you wish to use the default Corex styling, you can use the class `pin-input` on the component. This requires to install `Mix.Tasks.Corex.Design` first and import the component css file. ```css @import "../corex/main.css"; @import "../corex/tokens/themes/neo/light.css"; @import "../corex/components/pin-input.css"; ``` You can then use modifiers ```heex <.pin_input class="pin-input pin-input--accent pin-input--lg" count={4}> <:label>Code ``` The `value` assign is the initial cell contents; it is serialized to `data-default-value` for Zag’s uncontrolled `defaultValue`. ''' defmodule Translation do @moduledoc """ Translation struct for PinInput component strings. Without gettext: `translation={%PinInput.Translation{ digit: "Box %{digit}" }}` With gettext: `translation={%PinInput.Translation{ digit: "Digit %{digit}" }}` (add to catalog; component calls gettext at render) """ defstruct [:digit] end @doc type: :component use Phoenix.Component alias Corex.PinInput.Anatomy.{Control, HiddenInput, Input, Label, Props, Root} alias Corex.PinInput.Connect alias Phoenix.LiveView alias Phoenix.LiveView.JS import Corex.Gettext, only: [gettext: 2] import Corex.Helpers, only: [validate_value!: 1, respond_to_fields: 1] attr(:id, :string, required: false) attr(:value, :list, default: [], doc: "Initial value (list of single-character strings). Sent as `data-default-value` for Zag `defaultValue`." ) attr(:count, :integer, default: 4, doc: "Number of input boxes") attr(:disabled, :boolean, default: false) attr(:invalid, :boolean, default: false) attr(:required, :boolean, default: false) attr(:read_only, :boolean, default: false) attr(:mask, :boolean, default: false) attr(:otp, :boolean, default: false) attr(:blur_on_complete, :boolean, default: false) attr(:select_on_focus, :boolean, default: false) attr(:name, :string, default: nil) attr(:form, :string, default: nil) attr(:dir, :string, default: "ltr", values: ["ltr", "rtl"]) attr(:orientation, :string, default: "vertical", values: ["horizontal", "vertical"]) attr(:type, :string, default: "numeric", values: ["alphanumeric", "numeric", "alphabetic"]) attr(:placeholder, :string, default: "○") attr(:on_value_change, :string, default: nil) attr(:on_value_change_client, :string, default: nil) attr(:on_value_complete, :string, default: nil) attr(:translation, Corex.PinInput.Translation, default: nil, doc: "Override translatable strings" ) attr(:errors, :list, default: [], doc: "Error messages to display (non-field API)") attr(:field, Phoenix.HTML.FormField, doc: "A form field, e.g. f[:code] or @form[:code]") attr(:rest, :global) slot :label, required: false do attr(:class, :string, required: false) end slot :error, required: false do attr(:class, :string, required: false) end def pin_input(%{field: %Phoenix.HTML.FormField{} = field} = assigns) do errors = if Phoenix.Component.used_input?(field), do: field.errors, else: [] value = form_field_to_pin_list(field) value_str = Enum.join(value, "") assigns |> assign(:field, nil) |> assign(:errors, Enum.map(errors, &Corex.Gettext.translate_error/1)) |> assign(:id, field.id) |> assign(:name, field.name) |> assign(:form, field.form.id) |> assign(:value, value) |> assign(:value_str, value_str) |> assign(:invalid, errors != []) |> pin_input() end def pin_input(assigns) do default_translation = %Translation{digit: "Digit %{digit}"} value = case assigns[:value] do v when is_binary(v) -> String.graphemes(v) v -> v end assigns = assigns |> assign_new(:errors, fn -> [] end) |> assign_new(:id, fn -> "pin-input-#{System.unique_integer([:positive])}" end) |> assign_new(:dir, fn -> "ltr" end) |> assign_new(:orientation, fn -> "horizontal" end) |> assign_new(:translation, fn -> default_translation end) |> assign(:translation, merge_translation(assigns.translation, default_translation)) |> assign(:value, validate_value!(value || [])) assigns = assign(assigns, :value_str, Enum.join(assigns.value, "")) ~H"""