| id | title |
|---|---|
circular-progress-bar |
Circular Progressbar |
Circular Progressbar widget can be used to show progress in a progress circle.
:::info
Any property having Fx button next to its field can be programmatically configured.
:::
| <div style={{ width:"100px"}}> Properties | <div style={{ width:"100px"}}> Description | <div style={{ width:"135px"}}> Expected Value |
|---|---|---|
| Text | Sets a text inside the progress circle. | It expects a String, you can also use js to dynamically update the text as the progress changes. |
| Progress | Sets the progress of the widget. | Progress should be an integer between 0 and 100. |
There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.
Under the General accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.
| <div style={{ width:"100px"}}> Layout | <div style={{ width:"100px"}}> Description |
|---|---|
| Show on desktop | Toggle on or off to display the widget in desktop view. You can programmatically determine the value by clicking on Fx to set the value {{true}} or {{false}}. |
| Show on mobile | Toggle on or off to display the widget in mobile view. You can programmatically determine the value by clicking on Fx to set the value {{true}} or {{false}}. |
| <div style={{ width:"100px"}}> Property | <div style={{ width:"100px"}}> Description | <div style={{ width:"135px"}}> Expected Value |
|---|---|---|
| Color | Defines stroke color. | HEX color code or choose color from color-picker. |
| Text color | Defines color of the text inside circular progress bar. | HEX color code or choose color from color-picker |
| Text size | Defines the size of the text | Value must between 0-100 |
| Stroke width | Defines the width of stroke | Value must between 0-100 |
| Counter clockwise | Whether to rotate progress bar in counterclockwise direction. | Accepts {{true}} and {{false}}, Default value is false |
| Circle ratio | Defines ratio of the full circle diameter the progressbar should use. | Accepts numerical value and the default is 1 |
| Visibility | Toggle on or off to control the visibility of the widget. | Programmatically change its value by clicking on the Fx button next to it. If {{false}} the widget will not be visible after the app is deployed. By default, it's set to {{true}} |
:::info Circular progress bar widget uses react-circular-progress package. Check the repo for further more details about properties and styles. :::