Skip to main content

Link


Link elements provide text-based navigation or inline actions. These elements appear as underlined or colored text and support clicks, icons, and event handling. Use links to route users to help pages, alternate flows, or informational content.

Properties

PropertyValueDescription
TypeLinkUI component type
GroupButtonBelongs to the "Button" group in UI catalog
Identifier30Unique element ID
PreviewSee image preview above
Read-onlyYAppears without requiring interaction
Text, IconYSupports both text and inline icons
EventYCan trigger click or navigation handlers
ValueOptional string content
MandatoryOptional element
ErrorDoes not support validation logic
MinNo minimum constraint
MaxNo maximum constraint
ChildrenNo nested children
ShadeNo background shading
ListNot a list container

Usage Example

<Link href="/help/mfa" label="Learn more" />

SDK Integration

The MFA Settings screen uses this element. It links to the SDK method:

Method: /account/authentication/enabled

Displays the current MFA status and offers an option to unlink the authenticator app.


Example UI Placement

LevelIDTypeValueDescription
1unlinkLinkUnlink Authenticator appNavigates to unlink process
1learn-moreLinkLearn moreOpens documentation or help center

Notes

  • Use links for low-emphasis navigational actions.
  • Pair with visual indicators if the action alters authentication or settings.
  • Always confirm that the link opens the correct destination or dialog.