Skip to main content

Link

Ant Design

The Link component shows clickable text that opens a URL or runs an action, such as a link to a help page or a record.

Properties​

Property
Description
Expected Value
TextText shown as the link.Text. Default: Link
HrefThe URL to open. Only web, email and phone links open. Leave it empty to use the link only for its On click event.Text
TargetWhere the link opens: _blank for a new tab, _self for the same tab._blank, _self. Default: _blank
UnderlineWhen the text is underlined: on hover, always or never (none).hover, always, none. Default: hover
StrongShows the text in bold.On or off. Default: Off
Show iconShows an external link icon after the text.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On clickTriggers when the user clicks the link.
On hoverTriggers when the pointer moves onto the link.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
ClickClicks the link, which opens Href and fires its On click event.components.link1.click()
Set hrefChanges the URL the link opens.components.link1.setHref("")
Set textChanges the link's text.components.link1.setChildren("")
Set visibilityShows the component when true, hides it when false.components.link1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.link1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.link1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
childrenText shown as the link.{{components.link1.children}}
hrefThe URL to open. Only web, email and phone links open. Leave it empty to use the link only for its On click event.{{components.link1.href}}
targetWhere the link opens: _blank for a new tab, _self for the same tab.{{components.link1.target}}
underlineWhen the text is underlined: on hover, always or never (none).{{components.link1.underline}}
strongShows the text in bold.{{components.link1.strong}}
showIconShows an external link icon after the text.{{components.link1.showIcon}}
isVisibleWhether the component is visible.{{components.link1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.link1.isLoading}}
isDisabledWhether the component is disabled.{{components.link1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.