Link

The Link UI component transforms text into a clickable element, enabling customers to perform actions such as navigating to another web page or a specific location within a page by clicking on it.

Preview

TextButtonOrLink.jpg

Code example

render('Checkout::Dynamic::Render', () => {
return <Link to="https://www.shopline.com">SHOPLINE</Link>
});

LinkProps

tip

Optional properties are marked with a ?. Properties without a ? are required.

to?

string

The target URL that the customer is redirected to after clicking.You must specify either this property or onPress, or both.


external?

boolean Default: false

Indicates whether to open the link in a new window or a tab. Valid values are:

  • true: Open in a new window.
  • false: Open in a tab.

id?

string

A unique identifier for the UI component. If this property is not set, the system will automatically generate a globally unique ID for this component.


language?

string

Indicates the text language for the link. This property is useful when the text is in a different language from the rest of the page. It allows assistive technologies like screen readers to apply the correct pronunciation. Refer to this file for valid values.


accessibilityLabel?

string

A label for this component. Configuring this feature directly sets the aria-label attribute, providing accessibility information for screen readers.


onPress?

() => void

The callback function that is executed when the link is pressed. If the to property is set, the callback function is executed first. Then the customer is redirected to the URL specified by to. You must specify either this property or onPress , or both.


Was this article helpful to you?