Link
Generates a link to the given URL
Provides similar capabilities to Phoenix's built-in link/2
function.
Options label
and class
can be set directly and will override anything in opts
.
All other options are forwarded to the underlying <a> tag.
<Link
label="Go to source"
to="https://github.com/surface-ui/surface/blob/main/lib/surface/components/link.ex"
opts={data: [confirm: "Are you sure?"]}
/>
# Public API
Name | Description | Type | Values | Default |
---|---|---|---|---|
id
| Id to apply to the link. |
:string
| — | — |
to
| Required. The page to link to. |
:any
| — | — |
values
| List values that will be sent as part of the payload triggered by an event. |
:keyword
| — |
[]
|
method
| The method to use with the link. |
:atom
| — |
:get
|
class
| Class or classes to apply to the link. |
:css_class
| — | — |
label
|
The label for the generated <a> element, if no content (default slot) is provided.
|
:string
| — | — |
opts
| Additional attributes to add onto the generated element. |
:keyword
| — |
[]
|
Name | Description | Arguments |
---|---|---|
default
|
The content of the generated <a> element. If no content is provided,
the value of property label is used instead.
| — |
Name | Description |
---|---|
keydown
|
Triggered when a key on the keyboard is pressed. |
keyup
|
Triggered when a key on the keyboard is released. |
window_keydown
|
Triggered when a key on the keyboard is pressed (window-level). |
window_keyup
|
Triggered when a key on the keyboard is released (window-level). |
blur
|
Triggered when the component loses focus. |
focus
|
Triggered when the component receives focus. |
window_blur
|
Triggered when the page loses focus. |
window_focus
|
Triggered when the page receives focus. |
click
|
Triggered when the component receives click. |
capture_click
|
Triggered when the component captures click. |
Name | Description |
---|