View Source AshAuthentication.Phoenix.Components.SignIn (ash_authentication_phoenix v1.8.2)

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.

See AshAuthentication.Phoenix.Overrides for more information.

Props

  • overrides - A list of override modules.
  • otp_app - The otp app to look for authenticated resources in

Summary

Types

@type props() :: %{optional(:overrides) => [module()]}