AshAuthentication.Phoenix.Components.SignOut (ash_authentication_phoenix v2.16.0)

View Source

Renders a sign-out confirmation form.

The form submits a DELETE request to the sign-out controller action, ensuring CSRF protection against logout CSRF attacks.

Props

  • sign_out_path - The path to submit the sign-out form to.
  • overrides - A list of override modules.

Overrides

This component provides the following overrides:

  • :root_class - CSS class for the root div element.
  • :form_class - CSS class for the form element.
  • :button_text - Text for the sign-out button.
  • :h2_class - CSS class for the heading.
  • :h2_text - Heading text.
  • :info_text - Informational text displayed below the heading.
  • :info_text_class - CSS class for the informational text.
  • :button_class - CSS class for the sign-out button.

See AshAuthentication.Phoenix.Overrides for more information.

Summary

Types

props()

Types

props()

@type props() :: %{:sign_out_path => String.t(), optional(:overrides) => [module()]}