Back to Tooljet

Circular Progressbar

docs/versioned_docs/version-2.50.0-LTS/widgets/circular-progressbar.md

3.20.154-lts3.4 KB
Original Source

Circular Progressbar

The Circular Progressbar component can be used to show progress in a progress circle.

<div style={{paddingTop:'24px'}}>

Properties

:::info Any property having fx button next to its field can be programmatically configured. :::

<div style={{ width:"100px"}}> Properties </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
TextSets a text inside the progress circle.It expects a String, you can also use js to dynamically update the text as the progress changes.
ProgressSets the progress of the component.Progress should be an integer between 0 and 100.
</div> <div style={{paddingTop:'24px'}}>

Component Specific Actions (CSA)

There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.

</div> <div style={{paddingTop:'24px'}}>

Exposed Variables

There are currently no exposed variables for the component.

</div> <div style={{paddingTop:'24px'}}>

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.

Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.

</div> <div style={{paddingTop:'24px'}}>

Devices

<div style={{ width:"100px"}}> Property </div><div style={{ width:"100px"}}> Description </div><div style={{width:"100px"}}> Expected Value </div>
Show on desktopMakes the component visible in desktop view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
Show on mobileMakes the component visible in mobile view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
</div> <div style={{paddingTop:'24px'}}>

Styles

<div style={{ width:"100px"}}> Property </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
ColorDefines stroke color.HEX color code or choose color from color-picker.
Text colorDefines color of the text inside circular progress bar.HEX color code or choose color from color-picker
Text sizeDefines the size of the textValue must between 0-100
Stroke widthDefines the width of strokeValue must between 0-100
Counter clockwiseWhether to rotate progress bar in counterclockwise direction.Accepts {{true}} and {{false}}, Default value is false
Circle ratioDefines ratio of the full circle diameter the progressbar should use.Accepts numerical value and the default is 1
VisibilityToggle on or off to control the visibility of the component.Programmatically change its value by clicking on the fx button next to it. If {{false}} the component will not be visible after the app is deployed. By default, it's set to {{true}}

:::info Circular progress bar component uses react-circular-progress package. Check the repo for further more details about properties and styles. :::

</div>