Circular Progress
Rocket 2.0
The Circular Progress component shows progress as a ring that fills from 0 to 100, such as the share of orders shipped or a task's completion.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Value (0 to 100) | How full the ring is, from 0 to 100. | Number. Default: 63 |
| Size (px) | Width and height of the ring, in pixels. The ring shrinks if its box is smaller. | Number. Default: 96 |
| Thickness (px) | Width of the ring's line, in pixels. | Number. Default: 8 |
| Ends | Shape of the ends of the filled part: Round or Flat. | Round, Flat. Default: Round |
| Centre text | What appears in the middle of the ring: Value shows the percentage, Custom shows Custom centre text, and None shows nothing. | Value, Custom, None. Default: Value |
| Custom centre text | Text shown in the middle of the ring when Centre text is Custom. | Text |
| Sub-label | Smaller text shown under the centre text, such as Complete. | Text. Default: Complete |
| Loading look | What the component shows while it is loading: a Spinner or a Skeleton placeholder. | Spinner, Skeleton. Default: Spinner |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets 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 desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows 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 value | Sets how full the ring is to Value, kept between 0 and 100. | components.circularprogress1.setValue("") |
| Set visibility | Shows the component when true, hides it when false. | components.circularprogress1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.circularprogress1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.circularprogress1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
value | How full the ring is, from 0 to 100. | {{components.circularprogress1.value}} |
size | Width and height of the ring, in pixels. The ring shrinks if its box is smaller. | {{components.circularprogress1.size}} |
thickness | Width of the ring's line, in pixels. | {{components.circularprogress1.thickness}} |
lineCap | Shape of the ends of the filled part: Round or Flat. | {{components.circularprogress1.lineCap}} |
centerText | What appears in the middle of the ring: Value shows the percentage, Custom shows Custom centre text, and None shows nothing. | {{components.circularprogress1.centerText}} |
text | Text shown in the middle of the ring when Centre text is Custom. | {{components.circularprogress1.text}} |
label | Smaller text shown under the centre text, such as Complete. | {{components.circularprogress1.label}} |
loadingIndicator | What the component shows while it is loading: a Spinner or a Skeleton placeholder. | {{components.circularprogress1.loadingIndicator}} |
isVisible | Whether the component is visible. | {{components.circularprogress1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.circularprogress1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.circularprogress1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Bar color | Theme: Brand primary |
| Track color | Theme: Brand primary |
| Centre text color | Theme: Primary text |
| Sub-label color | Theme: Placeholder text |
| Alignment | Center |
| Box shadow | 0px 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.