mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 20:19:13 +00:00
83 lines
2.0 KiB
Markdown
83 lines
2.0 KiB
Markdown
# Progress Ring
|
|
|
|
[component-header:sl-progress-ring]
|
|
|
|
Progress rings are used to show the progress of a determinate operation in a circular fashion.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="25"></sl-progress-ring>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Size
|
|
|
|
Use the `--size` custom property to set the diameter of the progress ring.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" style="--size: 200px;"></sl-progress-ring>
|
|
```
|
|
|
|
### Track Width
|
|
|
|
Use the `--track-width` custom property to set the width of the progress ring's track.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" style="--track-width: 10px;"></sl-progress-ring>
|
|
```
|
|
|
|
### Colors
|
|
|
|
To change the color, use the `--track-color` and `--indicator-color` custom properties.
|
|
|
|
```html preview
|
|
<sl-progress-ring
|
|
value="50"
|
|
style="
|
|
--track-color: pink;
|
|
--indicator-color: deeppink;
|
|
"
|
|
></sl-progress-ring>
|
|
```
|
|
|
|
### Labels
|
|
|
|
Use the `label` attribute to label the progress ring and tell assistive devices how to announce it.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" label="Upload progress"></sl-progress-ring>
|
|
```
|
|
|
|
### Showing Values
|
|
|
|
Use the default slot to show a label.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" class="progress-ring-values" style="margin-bottom: .5rem;">50%</sl-progress-ring>
|
|
|
|
<br>
|
|
|
|
<sl-button circle><sl-icon name="dash"></sl-icon></sl-button>
|
|
<sl-button circle><sl-icon name="plus"></sl-icon></sl-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>
|
|
```
|
|
|
|
[component-metadata:sl-progress-ring]
|