Progress Bar

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

Examples

Basic Progress Bar

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

sl-progress-bar value="50"

import SlProgressBar from '@teamshares/shoelace/dist/react/progress-bar';

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

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>

sl-progress-bar value="50" label="Upload progress"

import SlProgressBar from '@teamshares/shoelace/dist/react/progress-bar';

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

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>

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

import SlProgressBar from '@teamshares/shoelace/dist/react/progress-bar';

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

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="minus" label="Decrease"></sl-icon></sl-button>
<sl-button circle><sl-icon name="plus" label="Increase"></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>

sl-progress-bar.progress-bar-values value="50" 50%
br
sl-button circle="true"
  sl-icon name="minus" label="Decrease"
sl-button circle="true"
  sl-icon name="plus" label="Increase"

javascript:
  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}%`;
  });

import { useState } from 'react';
import SlButton from '@teamshares/shoelace/dist/react/button';
import SlIcon from '@teamshares/shoelace/dist/react/icon';
import SlProgressBar from '@teamshares/shoelace/dist/react/progress-bar';

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="minus" label="Decrease" />
      </SlButton>

      <SlButton circle onClick={() => adjustValue(10)}>
        <SlIcon name="plus" label="Increase" />
      </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>

sl-progress-bar indeterminate="true"

import SlProgressBar from '@teamshares/shoelace/dist/react/progress-bar';

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

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

<script type="module" src="https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.1.0/cdn/components/progress-bar/progress-bar.js"></script>

import 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.1.0/cdn/components/progress-bar/progress-bar.js';

import '@shoelace-style/shoelace/dist/components/progress-bar/progress-bar.js';

import SlProgressBar from '@shoelace-style/shoelace/dist/react/progress-bar';

Slots

Learn more about using slots.

Properties

Learn more about attributes and properties.

Custom Properties

Learn more about customizing CSS custom properties.

Parts

Learn more about customizing CSS parts.