Skip to main content

Text

Ant Design

The Text component is Ant Design's paragraph text. It shows body text such as descriptions, notes and help text, with optional styling and a copy button.

Properties​

Property
Description
Expected Value
TextText to show. Line breaks in it are kept.Text. Default: Add a short description here.
TypeColor of the text. secondary is a muted gray, and success, warning and danger use the theme's status colors.default, secondary, success, warning, danger. Default: default
StrongShows the text in bold.On or off. Default: Off
ItalicShows the text in italics.On or off. Default: Off
CodeShows the text in a monospace code style with a light background.On or off. Default: Off
CopyableShows a copy icon after the text that copies it to the clipboard.On or off. Default: Off
Ellipsis rowsNumber of lines shown before the text is cut with an ellipsis. Hovering shows the full text. 0 shows all of it.Number. Default: 0
AlignHorizontal alignment of the text.left, center, right. Default: left

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
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.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

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
Set visibilityShows the component when true, hides it when false.components.text1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.text1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.text1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
childrenText to show. Line breaks in it are kept.{{components.text1.children}}
typeColor of the text. secondary is a muted gray, and success, warning and danger use the theme's status colors.{{components.text1.type}}
strongShows the text in bold.{{components.text1.strong}}
italicShows the text in italics.{{components.text1.italic}}
codeShows the text in a monospace code style with a light background.{{components.text1.code}}
copyableShows a copy icon after the text that copies it to the clipboard.{{components.text1.copyable}}
ellipsisNumber of lines shown before the text is cut with an ellipsis. Hovering shows the full text. 0 shows all of it.{{components.text1.ellipsis}}
alignHorizontal alignment of the text.{{components.text1.align}}
isVisibleWhether the component is visible.{{components.text1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.text1.isLoading}}
isDisabledWhether the component is disabled.{{components.text1.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.