<ProgressCircular />

This component displays a circular progress indicator. It can either be used to show how much of a task has been completed or to show a looping animation to indicate that an operation is currently running.

Tutorial

Progress

There are two components for indicating progress: ProgressBar and ProgressCircular. As the names imply, the ProgressBar displays a linear progress bar while the ProgressCircular displays a circular progress indicator.

They have the ability to show the current progress or a looping animation in cases where the current progress is not known.

Both components implement the same props.

To change the progress the value property is used. It should be a value between 0 and 100.

<ProgressBar value={this.state.currentProgress} />
<ProgressCircular value={this.state.currentProgress} />

Secondary value

It is sometimes necessary to display two different values in the same progress indicator. An example could be an app that streams a video. The progress bar could show both how much of the video has elapsed in addition to how much of the video that has been buffered.

To do this the secondaryValue property can be used.

<ProgressBar
  value={this.state.elapsed}
  secondaryValue={this.state.buffered}
/>

Indeterminate mode

There is also an indeterminate property which makes the component ignore both the value and secondaryValue properties. Instead, it show a looping animation. This can be useful for cases where the total progress is unknown, e.g. when waiting for some data to arrive.

<ProgressBar indeterminate />

Props

Name Type Default Value Description
modifier string The appearance of the progress indicator. Optional.
value number Current progress. Should be a value between 0 and 100. Optional.
secondaryValue bool Current secondary progress. Should be a value between 0 and 100. Optional.
indeterminate bool If this property is set, an infinite looping animation will be shown. Optional.

Discussion

Need Help?

If you have any questions, use our Community Forum or talk to us via Gitter chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.