AshAuthentication.Phoenix.Components.Password (ash_authentication_phoenix v2.12.2)

Generates sign in, registration and reset forms for a resource.

Component hierarchy

This is the top-most strategy-specific component, nested below AshAuthentication.Phoenix.Components.SignIn.

Children:

Props

strategy - The strategy configuration as per AshAuthentication.Info.strategy/2. Required.
overrides - A list of override modules.
gettext_fn - Optional text translation function.

Slots

sign_in_extra - rendered inside the sign-in form with the form passed as a slot argument.
register_extra - rendered inside the registration form with the form passed as a slot argument.
reset_extra - rendered inside the reset form with the form passed as a slot argument.
path - used as the base for links to other pages.
reset_path - the path to use for reset links.
register_path - the path to use for register links.

<.live_component
  module={AshAuthentication.Phoenix.Components.Password}
  strategy={AshAuthentication.Info.strategy!(Example.User, :password)}
  id="user-with-password"
  socket={@socket}
  overrides={[AshAuthentication.Phoenix.Overrides.Default]}>

  <:sign_in_extra :let={form}>
    <.input field={form[:capcha]} />
  </:sign_in_extra>

  <:register_extra :let={form}>
    <.input field={form[:name]} />
  </:register_extra>

  <:reset_extra :let={form}>
    <.input field={form[:capcha]} />
  </:reset_extra>
</.live_component>

Overrides

This component provides the following overrides:

:root_class - CSS class for the root div element.
:hide_class - CSS class to apply to hide an element.
:show_first - The form to show on first load. Either :sign_in or :register. Only relevant if paths aren't set for them in the router.
:interstitial_class - CSS class for the div element between the form and the button.
:sign_in_toggle_text - Toggle text to display when the sign in form is not showing (or nil to disable).
:register_toggle_text - Toggle text to display when the register form is not showing (or nil to disable).
:reset_toggle_text - Toggle text to display when the reset form is not showing (or nil to disable).
:toggler_class - CSS class for the toggler a element.
:register_form_module - The Phoenix component to be used for the registration form. Defaults to AshAuthentication.Phoenix.Components.Password.RegisterForm.
:sign_in_form_module - The Phoenix component to be used for the sign in form. Defaults to AshAuthentication.Phoenix.Components.Password.SignInForm.
:reset_form_module - The Phoenix component to be used for the reset form. Defaults to AshAuthentication.Phoenix.Components.Password.ResetForm.
:slot_class - CSS class for the div surrounding the slot.

See AshAuthentication.Phoenix.Overrides for more information.

Summary

Types

props()

Types

props()

@type props() :: %{
  :strategy => AshAuthentication.Strategy.t(),
  optional(:live_action) => :sign_in | :register,
  optional(:path) => String.t(),
  optional(:current_tenant) => String.t(),
  optional(:context) => map(),
  optional(:overrides) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}