Link
Make destinations easy to recognize in running text.
Preview
Choose an example destination. The preview updates locally without leaving this page.
Example
<.ui_link href="/components">Components</.ui_link>
API contract
ui_link/1
uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
href |
:string |
Yes | — |
Any value matching the declared type |
color |
:atom |
No | nil |
[nil, :neutral, :primary, :secondary, :accent, :info, :success, :warning, :error] |
hover |
:boolean |
No | false |
Any value matching the declared type |
class |
:any |
No | nil |
Any value matching the declared type |
rest |
:global |
No | — |
global includes ["download", "hreflang", "referrerpolicy", "rel", "target", "type"] |
| Slot | Required | Slot attributes |
|---|---|---|
inner_block |
Yes | No slot attributes |
States and behavior
Default and caller-supplied variants preserve semantic daisyUI colors and additive classes.
Keyboard and accessibility
Behavioral tests
These automated checks are applied to this component by the package and documentation test suites.
-
ExUnit
Styled native link
Preserves the link destination while applying hover and semantic color modifiers.
test/vaylan_ui/catalog_test.exs -
Browser
Rendered interaction
Clicks the rendered example link and verifies that the component documentation URL does not change.
examples/docs/assets/test/browser-smoke.mjs -
Docs
Preview behavior contract
Classified as navigation. Choose an example destination. The preview updates locally without leaving this page.
examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs -
Docs
Stable public component page
Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.
examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs