Skip to main content

Link

Makes text interactive, allowing users to navigate to other pages or perform specific actions. Supports standard URLs, custom protocols, and navigation within Shopify or app pages.

Anchor to propertiesProperties

Anchor to accessibilityLabel
accessibilityLabel
string

A label that describes the purpose or contents of the Link. It will be read to users using assistive technologies such as screen readers.

Use this when using only an icon or the content of the link is not enough context for users using assistive technologies.

Anchor to command
command
'--auto' | '--show' | '--hide' | '--toggle'
Default: '--auto'

Sets the action the command should take when this clickable is activated.

See the documentation of particular components for the actions they support.

  • --auto: a default action for the target component.
  • --show: shows the target component.
  • --hide: hides the target component.
  • --toggle: toggles the target component.
Anchor to commandFor
commandFor
string

Sets the element the commandFor should act on when this clickable is activated.

Anchor to download
download
string

Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs, or the blob: and data: schemes.

Anchor to href
href
string

The URL to link to.

  • If set, it will navigate to the location specified by href after executing the click event.
  • If a commandFor is set, the command will be executed instead of the navigation.
Anchor to interestFor
interestFor
string

Sets the element the interestFor should act on when this clickable is activated.

Anchor to lang
lang
string

Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. Reference of values ("subtag" label)

Anchor to target
target
"auto" | | "_blank" | "_self" | "_parent" | "_top"

Specifies where to display the linked URL.

Anchor to tone
tone
"critical" | "auto" | "neutral"

Sets the tone of the Link, based on the intention of the information being conveyed.

Was this section helpful?

Anchor to eventsEvents

Learn more about registering events.

Anchor to click
click
<typeof tagName> | null
Was this section helpful?

Code

<s-link href="#beep">fufilling orders</s-link>

Preview