Skip to content
Primer Design System

Primer Design System

Link

Links are used to apply styles to hyperlink text.

On this page

v0.24.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

NameDefaultDescription
href

nil

String

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

:default

Symbol

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

muted

false

Boolean

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

underline

false

Boolean

Whether or not to underline the link.

system_arguments

N/A

Hash

System arguments

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.

NameDefaultDescription
type

:description

Symbol

One of :description or :label.

system_arguments

N/A

Hash

Same arguments as Tooltip.