Current section

Files

Jump to
corex lib components password_input.ex
Raw

lib/components/password_input.ex

defmodule Corex.PasswordInput do
@moduledoc ~S'''
Phoenix implementation of [Zag.js Password Input](https://zagjs.com/components/react/password-input).
## Examples
### Basic
```heex
<.password_input id="pwd" class="password-input">
<:label>Password</:label>
<:visible_indicator><.icon name="hero-eye" /></:visible_indicator>
<:hidden_indicator><.icon name="hero-eye-slash" /></:hidden_indicator>
</.password_input>
```
## Styling
Use data attributes to target elements:
```css
[data-scope="password-input"][data-part="root"] {}
[data-scope="password-input"][data-part="label"] {}
[data-scope="password-input"][data-part="control"] {}
[data-scope="password-input"][data-part="input"] {}
[data-scope="password-input"][data-part="visibility-trigger"] {}
[data-scope="password-input"][data-part="indicator"] {}
```
If you wish to use the default Corex styling, you can use the class `password-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/password-input.css";
```
You can then use modifiers
```heex
<.password_input class="password-input password-input--accent password-input--lg">
<:visible_indicator><.icon name="hero-eye" /></:visible_indicator>
<:hidden_indicator><.icon name="hero-eye-slash" /></:hidden_indicator>
</.password_input>
```
Learn more about modifiers and [Corex Design](https://corex-ui.com/components/password-input#modifiers)
'''
@doc type: :component
use Phoenix.Component
alias Corex.PasswordInput.Anatomy.{
Props,
Root,
Label,
Control,
Input,
VisibilityTrigger,
Indicator
}
alias Corex.PasswordInput.Connect
attr(:id, :string, required: false)
attr(:visible, :boolean, default: false)
attr(:controlled_visible, :boolean, default: false)
attr(:disabled, :boolean, default: false)
attr(:invalid, :boolean, default: false)
attr(:read_only, :boolean, default: false)
attr(:required, :boolean, default: false)
attr(:ignore_password_managers, :boolean, default: false)
attr(:name, :string, default: nil)
attr(:form, :string, default: nil)
attr(:dir, :string, default: nil, values: [nil, "ltr", "rtl"])
attr(:auto_complete, :string,
default: "current-password",
values: ["current-password", "new-password"]
)
attr(:on_visibility_change, :string, default: nil)
attr(:on_visibility_change_client, :string, default: nil)
attr(:rest, :global)
slot(:label, required: false)
slot(:visible_indicator, required: true, doc: "Icon shown when password is visible")
slot(:hidden_indicator, required: true, doc: "Icon shown when password is hidden")
def password_input(assigns) do
assigns =
assigns
|> assign_new(:id, fn -> "password-input-#{System.unique_integer([:positive])}" end)
|> assign_new(:dir, fn -> "ltr" end)
~H"""
<div
id={@id}
phx-hook="PasswordInput"
{@rest}
{Connect.props(%Props{
id: @id,
visible: @visible,
controlled_visible: @controlled_visible,
disabled: @disabled,
invalid: @invalid,
read_only: @read_only,
required: @required,
ignore_password_managers: @ignore_password_managers,
name: @name,
form: @form,
dir: @dir,
auto_complete: @auto_complete,
on_visibility_change: @on_visibility_change,
on_visibility_change_client: @on_visibility_change_client
})}
>
<div phx-update="ignore" {Connect.root(%Root{id: @id, dir: @dir})}>
<label :if={@label != []} {Connect.label(%Label{id: @id, dir: @dir})}>
{render_slot(@label)}
</label>
<div {Connect.control(%Control{id: @id, dir: @dir})}>
<input type="password" {Connect.input(%Input{id: @id, disabled: @disabled})} />
<button type="button" {Connect.visibility_trigger(%VisibilityTrigger{id: @id, dir: @dir})}>
<span {Connect.indicator(%Indicator{id: @id, dir: @dir})} data-state={if @visible, do: "visible", else: "hidden"}>
<span data-visible="" aria-hidden="true">{render_slot(@visible_indicator)}</span>
<span data-hidden="" aria-hidden="true">{render_slot(@hidden_indicator)}</span>
</span>
</button>
</div>
</div>
</div>
"""
end
end