Learn about the ProgressBar component for use in UI extensions.
ProgressBar
component renders a visual indicator showing a numeric and/or percentage-based representation of progress. The percentage is calculated based on the maximum possible value specified in the component.
Prop | Type | Description |
---|---|---|
title | String | The text that displays above the progress bar. |
showPercentage | Boolean | When set to true , the progress bar will display the completion percentage. Default is false . |
value | Number | The number representing the progress so far. Default is 0 . |
maxValue | Number | The maximum value of the progress bar. Default is 100 . |
valueDescription | String | The text that explains the current state of the value property. For example, "150 out of 250" . |
variant | 'success' (default) | 'warning' | 'danger' | The color to indicate progress sentiment. |
aria-label | String | The accessibility label. |
'success'
: a green bar to indicate movement towards a positive goal or outcome.'warning'
: a yellow bar to indicate movement towards a negative outcome or limitation.'danger'
: a red bar to indicate movement towards an extremely negative outcome or when a limitation has been reached.showPercentage
prop to give the user more information about the status of the progress.