Link

Link makes text interactive so customers can perform an action, such as navigating to another location.

import {
  reactExtension,
  Link,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <Link to="https://www.shopify.ca/climate/sustainability-fund">
      Sustainability fund
    </Link>
  );
}

import {extension, Link} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
  const link = root.createComponent(
    Link,
    {to: 'https://www.shopify.ca/climate/sustainability-fund'},
    'Sustainability fund',
  );

  root.appendChild(link);
});

LinkProps

LinkProps

accessibilityLabel

A label used for buyers using assistive technologies. When set, any `children` supplied to this component will not be announced to screen reader users.

activateAction

Sets the action the `activateTarget` should take when this pressable is activated. Supported actions by component: | Component | Supported Actions | Default ('auto') | |---------------|-------------------|-------------------| | [`ClipboardItem`](/docs/api/checkout-ui-extensions/latest/clipboarditem) | 'copy' | 'copy' |

activateTarget

ID of a component that should respond to activations (e.g. clicks) on this pressable. See `activateAction` for how to control the behavior of the target.

appearance

Specify the color of the link. `monochrome` will take the color of its parent.

external

Open the link in a new window or tab. If the link points to a domain other than your Storefront, it will always open in a new tab.

id

Unique identifier. Typically used as a target for another component’s controls to associate an accessible label with an action.

language

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](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)

onPress

Callback when pressed. If `to` is set, it will execute the callback and then navigate to the location specified by `to`.

overlay

An overlay component to render when the user interacts with the component.

to

Destination to navigate to. You must provide either this property, `onPress`, or both.

toggles

The component's identifier whose visibility will be toggled when this component is actioned.

Appearance

'base' | 'accent' | 'decorative' | 'interactive' | 'subdued' | 'info' | 'success' | 'warning' | 'critical' | 'monochrome'

Related

• Button