<cs-progress-ring>
StableFeedbackSince 0.1

Progress rings show how far along a determinate operation is using a circular indicator. Use them as a compact alternative to progress bars when horizontal space is limited.

Examples

Label

Use the label attribute to tell assistive devices how to announce the progress ring.

Size

Use the --cs-progress-ring-size custom property to set the diameter of the ring.

Track & Indicator Width

Use the --cs-track-width and --cs-progress-ring-indicator-width custom properties to set the width of the ring’s track and indicator independently.

Colors

Use the --cs-track-color and --cs-indicator-color custom properties to recolor the ring.

Showing Values

Use the default slot to show a value inside the ring.

50%

API

Importing

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.

npm Self-Hosted React
import '@cruglobal/cornerstone-components/components/progress-ring/progress-ring.js';
import './cornerstone/components/progress-ring/progress-ring.js';
import CsProgressRing from '@cruglobal/cornerstone-components/react/progress-ring/index.js';

Slots

Learn more about using slots.

NameDescription
(default)A label to show inside the ring.

Attributes & Properties

Learn more about attributes and properties.

PropertyAttributeDescriptionTypeDefaultReflects
labellabelA custom label for assistive devices.string''—
valuevalueThe current progress as a percentage, 0 to 100.number0Yes

CSS Custom Properties

Learn more about CSS custom properties.

NameDescriptionDefault
--cs-indicator-colorThe color of the indicator.var(--cs-color-brand-fill-loud)
--cs-progress-ring-indicator-transition-durationThe duration of the indicator's transition when the value changes.0.35s
--cs-progress-ring-indicator-widthThe width of the indicator. Defaults to the track width.var(--cs-track-width)
--cs-progress-ring-sizeThe diameter of the progress ring (cannot be a percentage).8rem
--cs-track-colorThe color of the track.var(--cs-color-neutral-fill-normal)
--cs-track-widthThe width of the track.0.25em

CSS Parts

Learn more about CSS parts.

NameDescriptionCSS selector
indicatorThe progress ring's indicator.::part(indicator)
labelThe progress ring label.::part(label)
progress-ringThe component's outer wrapper.::part(progress-ring)
trackThe progress ring's track.::part(track)