Packages
surface
0.10.0
0.12.3
0.12.2
0.12.1
0.12.0
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.0
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.6
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.1
0.2.0
0.1.1
0.1.0
0.1.0-alpha.2
0.1.0-alpha.1
0.1.0-alpha.0
A component based library for Phoenix LiveView
Current section
Files
Jump to
Current section
Files
lib/surface/components/live_redirect.ex
defmodule Surface.Components.LiveRedirect do
@moduledoc """
Defines a link that will **redirect** to a new LiveView.
Provides similar capabilities to Phoenix's built-in `live_redirect/2`
function.
The current LiveView will be shut down and a new one will be mounted
in its place, without reloading the whole page. This can
also be used to remount the same LiveView, in case you want to start
fresh. If you want to navigate to the same LiveView without remounting
it, use `<LivePatch>` instead.
"""
use Surface.Component
@doc "The required path to link to"
prop to, :string, required: true
@doc "The flag to replace the current history or push a new state"
prop replace, :boolean, default: false
@doc "The CSS class for the generated `<a>` element"
prop class, :css_class, default: ""
@doc """
The label for the generated `<a>` element, if no content (default slot) is provided.
"""
prop label, :string
@doc """
Additional attributes to add onto the generated element
"""
prop opts, :keyword, default: []
@doc """
The content of the generated `<a>` element. If no content is provided,
the value of property `label` is used instead.
"""
slot default
def render(assigns) do
~F"""
<a
href={@to}
class={@class}
data-phx-link="redirect"
data-phx-link-state={if @replace, do: "replace", else: "push"}
:attrs={@opts}
><#slot>{@label}</#slot></a>
"""
end
end