AshAuthentication.Phoenix.Components.Confirm.Form (ash_authentication_phoenix v2.10.1)

View Source

Generates a default confirmation form.

Component hierarchy

This is a child of AshAuthentication.Phoenix.Components.Confirm.

Children:

Props

  • token - The confirmation token.
  • socket - Phoenix LiveView socket. This is needed to be able to retrieve the correct CSS configuration. Required.
  • strategy - The configuration map as per AshAuthentication.Info.strategy/2. Required.
  • label - The text to show in the submit label. Generated from the strategy name (via Phoenix.Naming.humanize/1) if not supplied. Set to false to disable.
  • overrides - A list of override modules.
  • gettext_fn - Optional text translation function.

Overrides

This component provides the following overrides:

  • :root_class - CSS class for the root div element.
  • :label_class - CSS class for the h2 element.
  • :form_class - CSS class for the form element.
  • :disable_button_text - Text for the submit button when the request is happening.

See AshAuthentication.Phoenix.Overrides for more information.

Summary

Types

props()

Types

props()

@type props() :: %{
  :socket => Phoenix.LiveView.Socket.t(),
  :strategy => AshAuthentication.Strategy.t(),
  :token => String.t(),
  optional(:label) => String.t() | false,
  optional(:auth_routes_prefix) => String.t(),
  optional(:overrides) => [module()],
  optional(:current_tenant) => term(),
  optional(:gettext_fn) => {module(), atom()}
}