Packages
ash_authentication_phoenix
3.0.0-rc.4
3.0.0-rc.9
3.0.0-rc.8
3.0.0-rc.7
3.0.0-rc.6
3.0.0-rc.4
3.0.0-rc.3
3.0.0-rc.2
3.0.0-rc.1
3.0.0-rc.0
2.17.2
2.17.1
2.17.0
2.16.0
2.15.0
2.14.1
2.14.0
2.13.1
2.13.0
2.12.2
2.12.1
2.12.0
2.11.0
2.10.5
2.10.4
2.10.3
2.10.2
2.10.1
2.10.0
2.9.0
2.8.0
2.7.0
2.6.3
2.6.2
2.6.1
2.6.0
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.4.8
2.4.7
2.4.6
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.0
2.2.1
2.2.0
2.1.11
2.1.10
2.1.9
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
2.0.0-rc.2
2.0.0-rc.1
2.0.0-rc.0
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.1
1.5.0
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.1
1.3.0
1.2.0
1.1.0
1.0.1
1.0.0
Phoenix integration for Ash Authentication
Current section
Files
Jump to
Current section
Files
lib/ash_authentication_phoenix/components/sign_out.ex
# SPDX-FileCopyrightText: 2022 Alembic Pty Ltd
#
# SPDX-License-Identifier: MIT
defmodule AshAuthentication.Phoenix.Components.SignOut do
use AshAuthentication.Phoenix.Overrides.Overridable,
root_class: "CSS class for the root `div` element.",
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.",
form_class: "CSS class for the form element.",
button_text: "Text for the sign-out button.",
button_class: "CSS class for the sign-out button."
@moduledoc """
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.
#{AshAuthentication.Phoenix.Overrides.Overridable.generate_docs()}
"""
use AshAuthentication.Phoenix.Web, :live_component
alias Phoenix.LiveView.{Rendered, Socket}
@type props :: %{
required(:sign_out_path) => String.t(),
optional(:overrides) => [module]
}
@doc false
@impl true
@spec update(props, Socket.t()) :: {:ok, Socket.t()}
def update(assigns, socket) do
socket =
socket
|> assign(assigns)
|> assign_new(:overrides, fn -> [AshAuthentication.Phoenix.Overrides.Default] end)
{:ok, socket}
end
@doc false
@impl true
@spec render(Socket.assigns()) :: Rendered.t()
def render(assigns) do
~H"""
<div class={override_for(@overrides, :root_class)}>
<h2 class={override_for(@overrides, :h2_class)}>
{override_for(@overrides, :h2_text)}
</h2>
<p :if={override_for(@overrides, :info_text)} class={override_for(@overrides, :info_text_class)}>
{override_for(@overrides, :info_text)}
</p>
<.form
for={%{}}
action={@sign_out_path}
method="delete"
class={override_for(@overrides, :form_class)}
>
<button type="submit" class={override_for(@overrides, :button_class)}>
{override_for(@overrides, :button_text)}
</button>
</.form>
</div>
"""
end
end