shoelace/docs/components/progress-bar.md

Progress Bar

[component-header:sl-progress-bar]

Progress bars are used to show the status of an ongoing operation.

<sl-progress-bar value="50"></sl-progress-bar>

import { SlProgressBar } from '@shoelace-style/shoelace/dist/react';

const App = () => <SlProgressBar value={50} />;

Examples

Custom Height

Use the --height custom property to set the progress bar's height.

<sl-progress-bar value="50" style="--height: 6px;"></sl-progress-bar>

import { SlProgressBar } from '@shoelace-style/shoelace/dist/react';

const App = () => <SlProgressBar value={50} style={{ '--height': '6px' }} />;

Labels

Use the label attribute to label the progress bar and tell assistive devices how to announce it.

<sl-progress-bar value="50" label="Upload progress"></sl-progress-bar>

import { SlProgressBar } from '@shoelace-style/shoelace/dist/react';

const App = () => <SlProgressBar value="50" label="Upload progress" />;

Showing Values

Use the default slot to show a value.

<sl-progress-bar value="50" class="progress-bar-values">50%</sl-progress-bar>

<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 progressBar = document.querySelector('.progress-bar-values');
  const subtractButton = progressBar.nextElementSibling.nextElementSibling;
  const addButton = subtractButton.nextElementSibling;

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

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

import { useState } from 'react';
import { SlButton, SlIcon, SlProgressBar } from '@shoelace-style/shoelace/dist/react';

const App = () => {
  const [value, setValue] = useState(50);

  function adjustValue(amount) {
    let newValue = value + amount;
    if (newValue < 0) newValue = 0;
    if (newValue > 100) newValue = 100;
    setValue(newValue);
  }

  return (
    <>
      <SlProgressBar value={value}>{value}%</SlProgressBar>

      <br />

      <SlButton circle onClick={() => adjustValue(-10)}>
        <SlIcon name="dash" />
      </SlButton>

      <SlButton circle onClick={() => adjustValue(10)}>
        <SlIcon name="plus" />
      </SlButton>
    </>
  );
};

Indeterminate

The indeterminate attribute can be used to inform the user that the operation is pending, but its status cannot currently be determined. In this state, value is ignored and the label, if present, will not be shown.

<sl-progress-bar indeterminate></sl-progress-bar>

import { SlProgressBar } from '@shoelace-style/shoelace/dist/react';

const App = () => <SlProgressBar indeterminate />;

[component-metadata:sl-progress-bar]