sp-progress-bar

Deprecation Warning
The over-background attribute has been deprecated and will be removed in a future release. Use static-color='white' instead.
Overview API Changelog

Overview

Section titled Overview

An <sp-progress-bar> is used to visually show the progression of a system operation such as downloading, uploading, processing, etc. By default, progress bars have a blue fill that shows the progress.

Usage

Section titled Usage

See it on NPM! How big is this package in your project? Try it on Stackblitz

yarn add @spectrum-web-components/progress-bar

Import the side effectful registration of <sp-progress-bar> via:

import '@spectrum-web-components/progress-bar/sp-progress-bar.js';

When looking to leverage the ProgressBar base class as a type and/or for extension purposes, do so via:

import { ProgressBar } from '@spectrum-web-components/progress-bar';

Anatomy

Section titled Anatomy

Progress bars have the following parts:

  • Label: Progress bars should have a label that gives context about the operation being performed. Use an ellipsis at the end of the label text to communicate that the process is in progress.
  • Value label: Progress bars can have a value label that gives detailed information about the progress. This value label works alongside the label and should not be displayed if the label itself is not displayed. The value label is always placed above the track. Use the progress attribute to set the value label.
<sp-progress-bar
        label="Generating images..."
        progress="58"
    ></sp-progress-bar>

Options

Section titled Options

Sizes

Section titled Sizes
Small Medium
<div
    style="width: 240px; height: 160px; display: flex; flex-direction: column; align-items: center; justify-content: space-around;"
>
    <sp-progress-bar
        size="m"
        label="Loaded a little"
        progress="22"
    ></sp-progress-bar>
</div>
Large Extra Large

Variants

Section titled Variants
Static white

When a progress bar needs to be placed on top of a colored background, use the static white progress bar as signified by [static-color="white"]. This progress bar uses a white opaque color no matter the background. Make sure the background offers enough contrast for the loader to be legible.

<div
    style="width: 240px; height: 160px; display: flex; flex-direction: column; align-items: center; justify-content: space-around; background-color: var(--spectrum-seafoam-900);"
>
    <sp-progress-bar
        label="Loaded a large amount"
        progress="77"
        static-color="white"
    ></sp-progress-bar>
</div>
Indeterminate Side label

Accessibility

Section titled Accessibility

An sp-progress-bar element will register itself as a role="progressbar" element in the accessibility tree. Any value applied to the label attribute will be used both to visibly label the element and to set the aria-label attribute on the host.

Include a label

Section titled Include a label

Progress bars should have a label that gives context about the operation being performed. Use an ellipsis at the end of the label text to communicate that the process is in progress.

In rare cases where a visible label is not desired, context is sufficient and an accessibility expert has reviewed the design, be sure to include an aria-label attribute or an aria-labelledby attribute to manually to ensure that the sp-progress-bar correctly fulfills its responsibilities to visitors of your site of all abilities.