Progress Bar
A progress bar is a progress indicator, either determinate (indicating a percentage of progression) or indeterminate (indicating a state of loading).
The progress bar comes in two different types, segregated into two main components.
-
The determinate type, when progress can be calculated against a target (download, upload, know sizes,...)
-
The indeterminate type, when there is progress but the completion cannot be determined (connection to a server, retrieving unknown amount of data,...)
Indeterminate
The indeterminate variant comes either as a bar bouncing from left to right or as an infinite loop by default.
You can select the bounce one just by setting the property animation to bounce.
Default infinite loop
<ProgressBar></ProgressBar>
//or
<ProgressBar variant="indeterminate"></ProgressBar>
Bounce animation
<ProgressBar animation="bounce"></ProgressBar>
//or
<ProgressBar variant="indeterminate" animation="bounce"></ProgressBar>
Determinate
The variantproperty is set to determinate with a value between 0 and 100 to specify the completed task using a progress bar.
<ProgressBar variant="determinate" value={20}></ProgressBar>
Show value
The value of a determinate progress bar is displayed by default. However, if showValue="false", the progress bar will not display its value.
<ProgressBar
variant="determinate"
value="20"
showValue="false"
></ProgressBar>
Color
By default, progress bars are emphasized (primary theme). Providing a visual prominence. For visual components where you don’t want to emphasize the progress bar component, the neutral theme is more appropriate for this deprioritize its focus on the screen.
Use the property color with primary and neutralvalues to change the colors. The primary color is set by default.
<ProgressBar color="neutral"></ProgressBar>
<ProgressBar variant="determinate" value="20" color="neutral" ></ProgressBar>
Progress bar with label and caption
<ProgressBar label="Downloading..." caption="Caption placeholder"></ProgressBar>
<ProgressBar variant="determinate" value={20} label="Downloading..." caption="Caption placeholder"></ProgressBar>
Sizes
Progress bars are available in three sizes to cater for the diverse range of use cases and devices that our business uses.
Set the size property to small, medium or large to change the size.
<ProgressBar size="small">...</ProgressBar>
<ProgressBar size="medium">...</ProgressBar>
<ProgressBar size="large">...</ProgressBar>
States
By default, the progress bar is in Loading state.
We also recommend using the Error state to make it obvious when the loading is encountering some issues.
Use state property with the .error or .success values to update states.
<ProgressBar state="error">...</ProgressBar>
<ProgressBar state="success">...</ProgressBar>