Skip to main content

Badge

Ant Design

The Badge component shows a small status dot with a label, such as Pending or Active, or a count bubble for things like unread items.

Properties​

Property
Description
Expected Value
StatusColor of the dot. processing is blue and pulses, default is gray.default, processing, success, warning, error. Default: default
TextLabel shown next to the dot or the count.Text. Default: Pending
CountA number to show in a bubble in place of the status dot. Leave it empty to show the dot.Number
Overflow countHighest number the count bubble shows. Larger counts show as this number with a plus, such as 99+.Number. Default: 99
ColorA color name such as blue or any CSS color for the dot or bubble. It overrides Status.Text

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

Exposed Variables​

Variable
Description
How To Access
statusColor of the dot. processing is blue and pulses, default is gray.{{components.badge1.status}}
textLabel shown next to the dot or the count.{{components.badge1.text}}
countA number to show in a bubble in place of the status dot. Leave it empty to show the dot.{{components.badge1.count}}
overflowCountHighest number the count bubble shows. Larger counts show as this number with a plus, such as 99+.{{components.badge1.overflowCount}}
colorA color name such as blue or any CSS color for the dot or bubble. It overrides Status.{{components.badge1.color}}
isVisibleWhether the component is visible.{{components.badge1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.badge1.isLoading}}
isDisabledWhether the component is disabled.{{components.badge1.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.