Progress Ring
<wa-progress-ring>
Progress rings are used to show the progress of a determinate operation in a circular fashion.
<wa-progress-ring value="25"></wa-progress-ring>
Examples
Jump to heading
Size
Jump to heading
Use the --size custom property to set the diameter of the progress ring.
<wa-progress-ring value="50" style="--size: 200px;"></wa-progress-ring>
Track and Indicator Width
Jump to heading
Use the --track-width and --indicator-width custom properties to set the width of the progress ring's track and indicator.
<wa-progress-ring value="50" style="--track-width: 6px; --indicator-width: 12px;"></wa-progress-ring>
Colors
Jump to heading
To change the color, use the --track-color and --indicator-color custom properties.
<wa-progress-ring value="50" style=" --track-color: pink; --indicator-color: deeppink; " > </wa-progress-ring>
Labels
Jump to heading
Use the default slot to show a label inside the progress ring.
<wa-progress-ring value="50" class="progress-ring-values" style="margin-bottom: .5rem;">50%</wa-progress-ring> <br /> <wa-button appearance="filled" circle><wa-icon name="minus" variant="solid" label="Decrease"></wa-icon></wa-button> <wa-button appearance="filled" circle><wa-icon name="plus" variant="solid" label="Increase"></wa-icon></wa-button> <script> const progressRing = document.querySelector('.progress-ring-values'); const subtractButton = progressRing.nextElementSibling.nextElementSibling; const addButton = subtractButton.nextElementSibling; addButton.addEventListener('click', () => { const value = Math.min(100, progressRing.value + 10); progressRing.value = value; progressRing.textContent = `${value}%`; }); subtractButton.addEventListener('click', () => { const value = Math.max(0, progressRing.value - 10); progressRing.value = value; progressRing.textContent = `${value}%`; }); </script>
Importing
Jump to heading
If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.
Import this component directly from the CDN:
import 'https://ka-f.webawesome.com/webawesome@0.14.0/components/progress-ring/progress-ring.js';
After installing Web Awesome via npm, import this component:
import '@awesome.me/webawesome/dist/components/progress-ring/progress-ring.js';
If you're self-hosting Web Awesome, import this component from your server:
import './webawesome/dist/components/progress-ring/progress-ring.js';
To import this component for React 18 or below, use the following code:
import WaProgressRing from '@awesome.me/webawesome/dist/react/progress-ring/index.js';
Slots
Jump to heading
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | A label to show inside the ring. |
Attributes & Properties
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
styles |
||
labellabel |
A custom label for assistive devices.
Type
stringDefault
'' |
||
valuevalue |
The current progress as a percentage, 0 to 100.
Type
numberDefault
0 |
|
CSS custom properties
Jump to heading
Learn more about CSS custom properties.
| Name | Description |
|---|---|
--indicator-color |
The color of the indicator.
|
--indicator-transition-duration |
The duration of the indicator's transition when the value changes.
|
--indicator-width |
The width of the indicator. Defaults to the track width.
|
--size |
The diameter of the progress ring (cannot be a percentage).
|
--track-color |
The color of the track.
|
--track-width |
The width of the track.
|
CSS parts
Jump to heading
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
base |
The component's base wrapper. |
::part(base)
|
indicator |
The progress ring's indicator. |
::part(indicator)
|
label |
The progress ring label. |
::part(label)
|
track |
The progress ring's track. |
::part(track)
|