shoelace/docs/components/progress-ring.md

1.8 KiB

Progress Ring

[component-header:sl-progress-ring]

Progress rings are used to show the progress of a determinate operation in a circular fashion.

<sl-progress-ring percentage="25"></sl-progress-ring>

Examples

Size

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

<sl-progress-ring percentage="50" style="--size: 200px;"></sl-progress-ring>

Track Width

Use the track-width attribute to set the width of the progress ring's track.

<sl-progress-ring percentage="50" stroke-width="10"></sl-progress-ring>

Colors

To change the color, use the --track-color and --indicator-color custom properties.

<sl-progress-ring 
  percentage="50" 
  style="
    --track-color: pink; 
    --indicator-color: deeppink;
  "
></sl-progress-ring>

Labels

Use the default slot to show a label.

<sl-progress-ring percentage="50" class="progress-ring-labels" 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-labels');
  const subtractButton = progressRing.nextElementSibling.nextElementSibling;
  const addButton = subtractButton.nextElementSibling;

  addButton.addEventListener('click', () => {
    const percentage = Math.min(100, progressRing.percentage + 10);
    progressRing.percentage = percentage;
    progressRing.textContent = `${percentage}%`;
  });

  subtractButton.addEventListener('click', () => {
    const percentage = Math.max(0, progressRing.percentage - 10)
    progressRing.percentage = percentage;
    progressRing.textContent = `${percentage}%`;
  });
</script>

[component-metadata:sl-progress-ring]