AshAuthentication.Phoenix.Components.Password.Input (ash_authentication_phoenix v2.12.1)

Function components for dealing with form input during password authentication.

Component hierarchy

These function components are consumed by AshAuthentication.Phoenix.Components.Password.SignInForm, AshAuthentication.Phoenix.Components.Password.RegisterForm and AshAuthentication.Phoenix.Components.ResetForm.

Overrides

This component provides the following overrides:

:label_class - CSS class for label elements.
:submit_class - CSS class for the form submit input element.
:field_class - CSS class for div elements surrounding the fields.
:input_class - CSS class for text/password input elements.
:identity_input_label - Label for identity field.
:identity_input_placeholder - Placeholder for identity field.
:password_input_label - Label for password field.
:password_confirmation_input_label - Label for password confirmation field.
:input_class_with_error - CSS class for text/password input elements when there is a validation error.
:error_ul - CSS class for the ul element on error lists.
:error_li - CSS class for the li elements on error lists.
:input_debounce - Number of milliseconds to debounce input by (or nil to disable).
:remember_me_class - CSS class for the div element surrounding the remember me field.
:remember_me_input_label - Label for remember me field.
:checkbox_class - CSS class for the input element of the remember me field.
:checkbox_label_class - CSS class for the label element of the remember me field.

See AshAuthentication.Phoenix.Overrides for more information.

Summary

Functions

error(assigns)

Generate a list of errors for a field (if there are any).

identity_field(assigns)

Generate a form field for the configured identity field.

password_confirmation_field(assigns)

Generate a form field for the configured password confirmation entry field.

password_field(assigns)

Generate a form field for the configured password entry field.

remember_me_field(assigns)

Generate a form field for the remember me field.

submit(assigns)

Generate an form submit button.

Functions

error(assigns)

@spec error(%{
  :socket => Phoenix.LiveView.Socket.t(),
  :form => AshPhoenix.Form.t(),
  :field => atom(),
  optional(:field_label) => String.Chars.t(),
  optional(:errors) => [{atom(), String.t()}],
  optional(:gettext_fn) => {module(), atom()}
}) :: Phoenix.LiveView.Rendered.t() | no_return()

Generate a list of errors for a field (if there are any).

Props

socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
form - An AshPhoenix.Form. Required.
field - The field for which to retrieve the errors. Required.
overrides - A list of override modules.
gettext_fn - Optional text translation function.

identity_field(assigns)

@spec identity_field(%{
  :socket => Phoenix.LiveView.Socket.t(),
  :strategy => AshAuthentication.Strategy.t(),
  :form => AshPhoenix.Form.t(),
  optional(:input_type) => :text | :email,
  optional(:overrides) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}) :: Phoenix.LiveView.Rendered.t() | no_return()

Generate a form field for the configured identity field.

Props

socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
strategy - The configuration map as per AshAuthentication.authenticated_resources/1. Required.
form - An AshPhoenix.Form. Required.
input_type - Either :text or :email. If not set it will try and guess based on the name of the identity field.
overrides - A list of override modules.
gettext_fn - Optional text translation function.

password_confirmation_field(assigns)

@spec password_confirmation_field(%{
  :socket => Phoenix.LiveView.Socket.t(),
  :strategy => AshAuthentication.Strategy.t(),
  :form => AshPhoenix.Form.t(),
  optional(:overrides) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}) :: Phoenix.LiveView.Rendered.t() | no_return()

Generate a form field for the configured password confirmation entry field.

Props

socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
strategy - The configuration map as per AshAuthentication.authenticated_resources/1. Required.
form - An AshPhoenix.Form. Required.
overrides - A list of override modules.
gettext_fn - Optional text translation function.

password_field(assigns)

@spec password_field(%{
  :socket => Phoenix.LiveView.Socket.t(),
  :strategy => AshAuthentication.Strategy.t(),
  :form => AshPhoenix.Form.t(),
  optional(:overrides) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}) :: Phoenix.LiveView.Rendered.t() | no_return()

Generate a form field for the configured password entry field.

Props

socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
strategy - The configuration map as per AshAuthentication.authenticated_resources/1. Required.
form - An AshPhoenix.Form. Required.
overrides - A list of override modules.
gettext_fn - Optional text translation function.

remember_me_field(assigns)

@spec remember_me_field(%{
  :socket => Phoenix.LiveView.Socket.t(),
  :strategy => AshAuthentication.Strategy.t(),
  :form => AshPhoenix.Form.t(),
  optional(:name) => atom(),
  optional(:overrides) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}) :: Phoenix.LiveView.Rendered.t() | no_return()

Generate a form field for the remember me field.

Props

socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
strategy - The configuration map as per AshAuthentication.authenticated_resources/1. Required.
form - An AshPhoenix.Form. Required.
name - The name of the field. Defaults to :remember_me.
overrides - A list of override modules.
gettext_fn - Optional text translation function.

submit(assigns)

@spec submit(%{
  :socket => Phoenix.LiveView.Socket.t(),
  :strategy => AshAuthentication.Strategy.t(),
  :form => AshPhoenix.Form.t(),
  :action => :sign_in | :register | :request_reset | :reset,
  optional(:label) => String.t(),
  optional(:overrides) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}) :: Phoenix.LiveView.Rendered.t() | no_return()

Generate an form submit button.

Props

socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
strategy - The configuration map as per AshAuthentication.authenticated_resources/1. Required.
form - An AshPhoenix.Form. Required.
action - Either :sign_in, :register, :request_reset or :reset. Required.
label - The text to show in the submit label. Generated from the configured action name (via Phoenix.Naming.humanize/1) if not supplied.
overrides - A list of override modules.
gettext_fn - Optional text translation function.