Progress Ring

lightning:progressRing

Displays a circular progress indicator to provide feedback about an action or process. This component requires API version 48.0 and later.

For Aura components only. For LWC development, use lightning-progress-ring.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App, Mobile Offline

A lightning:progressRing component shows a value from 0 to 100 in a compact, circular visualization with optional icons and color themes. The color fill is displayed in a clockwise or counterclockwise direction. It informs users the status of a process or action, such as loading data or saving updates.

This component implements styling from progress ring in the Lightning Design System.

This example creates a progress ring in a clockwise direction with a value of 75, which fills three quarters of the ring, or 75%.

1<lightning:progressRing value="75" />

Using Variants 

Use variants to change the ring’s styling to provide contextual feedback to users, such as whether an action is successful, active, at risk of failing, or unsuccessful.

By default, the progress ring fills in with green as the value increases, to indicate success.

1<lightning:progressRing value="80" />

To display an active step in blue, use the active-step variant. This variant indicates that the progress status is ongoing and not yet determined to be successful, at risk of failing, or unsuccessful.

1<lightning:progressRing value="80" variant="active-step" />

To indicate a problem with an action or process, use the warning variant. This variant displays the warning icon inside the ring and uses a yellow fill color.

1<lightning:progressRing value="80" variant="warning" />

To indicate an unsuccessful action or process, use the expired variant. This variant displays the error icon inside the ring and uses a red fill color.

1<lightning:progressRing value="80" variant="expired" />

To indicate a successful action or process, use the base-autocomplete variant. This variant is styled the same as the default base variant when the value is 0 to 99. When the value is 100, the success icon displays as a checkmark on a green background matching the fill color of the ring.

1<lightning:progressRing value="100" variant="base-autocomplete" />

Accessibility 

The warning, expired, and base-autocomplete variants provide icons and descriptive text for accessibility. The active-step variant currently does not have either, so it is not accessible. The active-step and base default variant appear the same except for color. Consider this accessibility limitation when using the active-step variant.

Attributes 

NameDescriptionTypeDefaultRequired
bodyThe body of the component. In markup, this is everything in the body of the tag.Aura.Component[]
directionControls which way the color flows from the top of the ring, either clockwise or counterclockwise. Valid values include fill and drain. The fill value corresponds to a color flow in the clockwise direction. The drain value indicates a color flow in the counterclockwise direction.Stringfill
sizeThe size of the progress ring. Valid values include medium and large.Stringmedium
valueThe percentage value of the progress ring. The value must be a number from 0 to 100. A value of 50 corresponds to a color fill of half the ring in a clockwise or counterclockwise direction, depending on the direction attribute.Integer0
variantChanges the appearance of the progress ring. Accepted variants include base, active-step, warning, expired, and base-autocomplete.Stringbase