Link

If true, the link will automatically show the spinner when the onClick function is called and it returns a promise. If false, the spinner will only show if the isLoading prop is set to true. By default, this is true.

The URL passed into the link component (or a tag)

The name of an icon (from Pluma Icons) to render in the link

Override an icon's vertical alignment. By default the alignment is uppercase when the position is leading, and lowercase when the position is trailing

Which side of the text the icon should be rendered on. leading renders the icon before the text, trailing renders it after.

What size to render the icon in (if an icon is provided)

The source URL of a custom image icon to render in the link. When provided, this will be rendered using the Image component with icon sizing. Use v2 sizing (icon-v2-sm, icon-v2-md, icon-v2-lg, icon-v2-xl) for new implementations. The image will always have alt="" as it is purely decorative - meaning comes from link text or aria-label.

Whether the link should be disabled (this prevents click handlers from firing)

Whether the link should render in an error state

When this flag is true, an a tag will be used instead of the provider's linkComponent, even if it exists. Additionally, target="_blank" rel="noopener noreferrer" will be added automatically

Shows a spinner in the link overlaid on top of the link's content. The link will act as if disabled while in the loading state.

Whether the link should be underlined

This is passed into the provider's linkComponent. It can be used by the link component implementation to handle replaceState instead of pushState

Whether the content of the link should be truncated if it overflows its container.

Legacy styling flag for backwards compatibility

The visual style variant of the link

This allows turning off the automatic addition of target="_blank" rel="noopener noreferrer". This can be used for links to other protocols like mailto: