Skip to main content

Circular Progress

Ant Design

The Circular Progress component shows a percentage as a ring, such as how much of a task or a quota is done.

Properties​

Property
Description
Expected Value
PercentHow full the ring is, from 0 to 100.Number. Default: 75
Size (px)Width and height of the ring, from 32 to 400 pixels. It shrinks to fit a smaller box.Number. Default: 120
Stroke widthThickness of the ring, as a percent of its size.Number. Default: 6
Line capShape of the ends of the filled part: round or square (butt).round, butt. Default: round
Typecircle is a full ring; dashboard is a ring with a gap at the bottom, like a gauge.circle, dashboard. Default: circle
CenterWhat shows in the middle: the percent, custom Text (custom) or nothing (none).percent, custom, none. Default: percent
TextText shown in the middle when Center is custom.Text
LabelCaption shown under the ring.Text
StatusColor of the ring. success is green and exception is red; with Center set to percent they show a check or a cross in place of the number.normal, success, exception, active. Default: normal

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 percentChanges how full the ring is, from 0 to 100.components.circularprogress1.setPercent("")
Set visibilityShows the component when true, hides it when false.components.circularprogress1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.circularprogress1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.circularprogress1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
percentHow full the ring is, from 0 to 100.{{components.circularprogress1.percent}}
sizeWidth and height of the ring, from 32 to 400 pixels. It shrinks to fit a smaller box.{{components.circularprogress1.size}}
strokeWidthThickness of the ring, as a percent of its size.{{components.circularprogress1.strokeWidth}}
strokeLinecapShape of the ends of the filled part: round or square (butt).{{components.circularprogress1.strokeLinecap}}
typecircle is a full ring; dashboard is a ring with a gap at the bottom, like a gauge.{{components.circularprogress1.type}}
formatWhat shows in the middle: the percent, custom Text (custom) or nothing (none).{{components.circularprogress1.format}}
textText shown in the middle when Center is custom.{{components.circularprogress1.text}}
labelCaption shown under the ring.{{components.circularprogress1.label}}
statusColor of the ring. success is green and exception is red; with Center set to percent they show a check or a cross in place of the number.{{components.circularprogress1.status}}
isVisibleWhether the component is visible.{{components.circularprogress1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.circularprogress1.isLoading}}
isDisabledWhether the component is disabled.{{components.circularprogress1.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.