AshAuthentication.Phoenix.Components.SignIn (ash_authentication_phoenix v2.12.1)

View Source

Renders sign in mark-up for an authenticated resource.

This means that it will render sign-in UI for all of the authentication strategies for a resource.

For each strategy configured on the resource a component name is inferred (e.g. AshAuthentication.Strategy.Password becomes AshAuthentication.Phoenix.Components.Password) and is rendered into the output.

Component hierarchy

This is the top-most authentication component.

Children:

Overrides

This component provides the following overrides:

  • :root_class - CSS class for the root div element.
  • :strategy_class - CSS class for a div surrounding each strategy component.
  • :show_banner - Whether or not to show the banner.
  • :authentication_error_container_class - CSS class for the container for the text of the authentication error.
  • :authentication_error_text_class - CSS class for the authentication error text.
  • :strategy_display_order - Whether to display the form or link strategies first. Accepted values are :forms_first or :links_first.

See AshAuthentication.Phoenix.Overrides for more information.

Props

  • otp_app - The otp app to look for authenticated resources in
  • live_action - The live_action being routed to
  • path - The path to use as the base for links
  • reset_path - The path to use for reset links
  • register_path - The path to use for register links
  • overrides - A list of override modules.
  • gettext_fn - Optional text translation function.

Summary

Types

props()

Types

props()

@type props() :: %{
  optional(:path) => String.t(),
  optional(:reset_path) => String.t(),
  optional(:register_path) => String.t(),
  optional(:current_tenant) => String.t(),
  optional(:context) => map(),
  optional(:overrides) => [module()],
  optional(:resources) => [module()],
  optional(:gettext_fn) => {module(), atom()}
}