Skip to main content

Icon

Ant Design

The Icon component shows a single icon, optionally on a tinted circle or square, such as a marker beside a heading or a clickable shortcut.

Properties​

Property
Description
Expected Value
IconThe icon to show, by its Ant Design name, such as TeamOutlined, or a plain word, such as users, cart or rocket.Text. Default: StarOutlined
Size (px)Size of the icon, from 8 to 200 pixels.Number. Default: 20
TypeColor of the icon. muted is a light gray; the others use the theme's colors.default, muted, primary, success, warning, danger. Default: default
ChipPuts the icon on a lightly tinted circle or square in the icon's color.none, circle, square. Default: none
Chip size (px)Width and height of the chip in pixels. It shrinks to fit a smaller box.Number. Default: 40

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 icon.
On hoverTriggers when the pointer moves onto the icon.

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
ClickFires the icon's On click event.components.icon1.click()
Set visibilityShows the component when true, hides it when false.components.icon1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.icon1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.icon1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
iconThe icon to show, by its Ant Design name, such as TeamOutlined, or a plain word, such as users, cart or rocket.{{components.icon1.icon}}
sizeSize of the icon, from 8 to 200 pixels.{{components.icon1.size}}
typeColor of the icon. muted is a light gray; the others use the theme's colors.{{components.icon1.type}}
chipPuts the icon on a lightly tinted circle or square in the icon's color.{{components.icon1.chip}}
chipSizeWidth and height of the chip in pixels. It shrinks to fit a smaller box.{{components.icon1.chipSize}}
isVisibleWhether the component is visible.{{components.icon1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.icon1.isLoading}}
isDisabledWhether the component is disabled.{{components.icon1.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.