Search

Link

While links have default styling in the app, some links deserve a little more ❤️


React Component

Sage Component

SageLink
Property Description Type Default

external

When set to true, target="_blank" will be added to the link.

Boolean

nil

help_link

When set to true, renders the link as a help affordance (a question-circle icon). Paired with show_label: false it is icon-only; label still names it, rendered as visually hidden text rather than removed.

Boolean

nil

html_attributes

Passes attributes straight onto the rendered <a>. A link with only an icon has no text to name it, so pass a name instead: html_attributes: { "aria-label": "Edit settings" }.

Hash

{}

label

Sets the text for the link. Overrides any content passed in.

String

nil

launch

When set to true, the launch icon will accompany the link text.

Boolean

nil

show_label

When set to true, the link text is visible; otherwise it exists in the DOM but is visually hidden.

Boolean

nil

url

Sets the destination url for the link.

String

nil