Link

Links are used to apply styles to hyperlink text.

v0.34.0BetaNot reviewed for accessibility

Description

Use Link for navigating from one page to another. Link styles anchor tags with default blue styling and hover text-decoration.

Arguments

NameTypeDefaultDescription
href
String

nil

URL to be used for the Link. Required. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered.

scheme
Symbol

:default

One of :default, :primary, or :secondary.

muted
Boolean

false

Uses light gray for Link color, and blue on hover.

underline
Boolean

false

Whether or not to underline the link.

system_arguments
Hash

N/A

Examples

Slots

tooltip

Tooltip that appears on mouse hover or keyboard focus over the link. Use tooltips sparingly and as a last resort. Important: This tooltip defaults to type: :description. In a few scenarios, type: :label may be more appropriate. The tooltip will appear adjacent to the anchor element. Both the tooltip and the anchor will be nested under a positioning wrapper. Consult the Tooltip documentation for more information.

NameTypeDefaultDescription
type
Symbol

:description

One of :description or :label.

system_arguments
Hash

N/A

Same arguments as Tooltip.