sp-progress-circle

NPM

1.0.0

Storybook

View Storybook

Try it on

webcomponents.dev
Examples API Changelog

Attributes and Properties #

Property Attribute Type Default Description indeterminate indeterminate boolean false label label string '' progress progress number 0 staticColor static-color 'white' | undefined

1.0.0 (2024-10-31) #

BREAKING CHANGES #

  • remove progress-circle overBackground property (#4750)

0.49.0 (2024-10-15) #

Features #

  • add static-color to replace static (#4808) (43cf086)

0.48.1 (2024-10-01) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.48.0 (2024-09-17) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.47.2 (2024-09-03) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.47.1 (2024-08-27) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.47.0 (2024-08-20) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.46.0 (2024-08-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.45.0 (2024-07-30) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.44.0 (2024-07-15) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.43.0 (2024-06-11) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.42.5 (2024-05-24) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.42.4 (2024-05-14) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.42.3 (2024-05-01) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.42.2 (2024-04-03) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.42.1 (2024-04-02) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.42.0 (2024-03-19) #

Bug Fixes #

  • progress-circle: remove aria-label only when set by label and changed label is empty (cdd181a)

Features #

  • asset: use core tokens (99e76f4)

0.41.2 (2024-03-05) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.41.1 (2024-02-22) #

Bug Fixes #

  • progress-circle: ensure size can be applied to non-"size" attribute bearing elements (2bc1065)

0.41.0 (2024-02-13) #

Features #

  • icon: use core tokens (a11ef6b)

0.40.5 (2024-02-05) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.40.4 (2024-01-29) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.40.3 (2024-01-11) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.40.2 (2023-12-18) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.40.1 (2023-12-05) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.40.0 (2023-11-16) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.39.4 (2023-11-02) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.39.3 (2023-10-18) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.39.2 (2023-10-13) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.39.1 (2023-10-06) #

Bug Fixes #

  • progress-circle,toast,tooltip: ensure complete dependency graph (#3701) (a5dfada)

0.39.0 (2023-09-25) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.38.0 (2023-09-05) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.37.0 (2023-08-18) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.36.0 (2023-08-18) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.35.0 (2023-07-31) #

Bug Fixes #

  • meter, progress-bar, progress-circle: use innerText when label is not provided (#3483) (59358c7)

0.34.0 (2023-07-11) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.33.2 (2023-06-14) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.33.0 (2023-06-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.32.0 (2023-06-01) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.31.0 (2023-05-17) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.30.0 (2023-05-03) #

Bug Fixes #

  • update to latest spectrum-css packages (a5ca19f)

Features #

  • adopt DNA@7 base Spectrum CSS (e08cafd)
  • delivery dev mode messages in various packages (62370a1)
  • include all Dev Mode files in side effects (f70817c)
  • progress-circle: replace circle-loader with progress-circle (a852140)
  • progress-circle: use core tokens (587ac63)
  • shared pkg versions, devmode define warning, registry-conflicts docs (6e49565)
  • use latest exports specification (a7ecf4b)

0.7.9 (2023-04-24) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.8 (2023-04-05) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.7 (2023-03-22) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.6 (2023-02-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.5 (2023-01-23) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.4 (2023-01-09) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.3 (2022-12-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.2 (2022-11-21) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.1 (2022-11-14) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.7.0 (2022-10-28) #

Features #

  • progress-circle: use core tokens (587ac63)

0.6.0 (2022-08-09) #

Features #

  • include all Dev Mode files in side effects (f70817c)

0.5.0 (2022-08-04) #

Features #

  • delivery dev mode messages in various packages (62370a1)

0.4.11 (2022-07-18) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.10 (2022-06-29) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.9 (2022-06-07) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.8 (2022-05-27) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.7 (2022-05-12) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.6 (2022-04-21) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.5 (2022-03-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.4 (2022-03-04) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.3 (2022-02-22) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.2 (2022-01-26) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.1 (2021-12-13) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.4.0 (2021-11-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.3.1 (2021-11-08) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.3.0 (2021-11-02) #

Features #

  • adopt DNA@7 base Spectrum CSS (e08cafd)

0.2.8 (2021-09-20) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.7 (2021-07-22) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.6 (2021-06-16) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.5 (2021-05-12) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.4 (2021-04-09) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.3 (2021-03-29) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.2 (2021-03-22) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.1 (2021-03-05) #

Note: Version bump only for package @spectrum-web-components/progress-circle

0.2.0 (2021-03-04) #

Features #

  • use latest exports specification (a7ecf4b)

0.1.1 (2021-02-11) #

Bug Fixes #

  • update to latest spectrum-css packages (a5ca19f)

0.1.0 (2021-02-02) #

Features #

  • progress-circle: replace circle-loader with progress-circle (a852140)

Description #

An <sp-progress-circle> shows the progression of a system operation such as downloading, uploading, processing, etc. in a visual way. It can represent determinate or indeterminate progress.

Usage #

See it on NPM! How big is this package in your project? Try it on webcomponents.dev

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

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

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

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

import { ProgressCircle } from '@spectrum-web-components/progress-circle';

Variants #

Default #

An <sp-progress-circle> is used to visually show the progression of a system operation such as downloading, uploading, processing, etc.

<div
    style="width: 250px; height: 150px; display: flex; align-items: center; justify-content: space-around;"
>
    <sp-progress-circle
        label="A small representation of a somewhat completed action"
        progress="71"
        size="s"
    ></sp-progress-circle>
    <sp-progress-circle
        label="A medium representation of a recently started action"
        progress="22"
    ></sp-progress-circle>
    <sp-progress-circle
        label="A large representation of an almost completed action"
        progress="86"
        size="l"
    ></sp-progress-circle>
</div>

Static color #

If you display your <sp-progress-cicle> element over the top of other content, e.g. an image or an alternate background color, it may become appropariate to update the colors with which the circle and loading progress indicator are delivered. To do this, leverage the static-color attribute with the value of white to ensure the content of your page is being delivered accessibly.

<div
    style="width: 250px; height: 150px; display: flex; align-items: center; justify-content: space-around;  background-color: rgba(0,0,0,0.4);"
>
    <sp-progress-circle
        label="A small representation of a partially completed action"
        progress="42"
        static-color="white"
        size="s"
    ></sp-progress-circle>
    <sp-progress-circle
        label="A medium representation of a barely started action"
        progress="7"
        static-color="white"
    ></sp-progress-circle>
    <sp-progress-circle
        label="A large representation of a somewhat completed action"
        progress="68"
        static-color="white"
        size="l"
    ></sp-progress-circle>
</div>

Indeterminate #

A progress circle can be either determinate or indeterminate as signified by [indeterminate]. By default, loaders are determinate. Use a determinate loader when progress can be calculated against a specific goal (e.g., downloading a file of a known size). Use an indeterminate loader when progress is happening but the time or effort to completion can’t be determined (e.g., attempting to reconnect to a server).

<div
    style="width: 250px; height: 150px; display: flex; align-items: center; justify-content: space-around;"
>
    <sp-progress-circle
        label="A small representation of an unclear amount of work"
        indeterminate
        size="s"
    ></sp-progress-circle>
    <sp-progress-circle
        label="A medium representation of an unclear amount of work"
        indeterminate
    ></sp-progress-circle>
    <sp-progress-circle
        label="A large representation of an unclear amount of work"
        indeterminate
        size="l"
    ></sp-progress-circle>
</div>

Size #

Progress Circles come in 3 sizes: small ([size="s"]), medium ([size="m"], default), or large ([size="l"]). These are available to fit various contexts. For example, the small loader can be used in place of an icon or in tight spaces, while the large one can be used for full-page loading.

Accessibility #

An sp-progress-circle element will register itself as a role="progressbar" element in the accessibility tree. Any value applied to the label attribute will be set as the aria-label attribute on the host. These two attributes can be used interchangably to ensure that the sp-progress-circle elements in your UI correctly fulfills its responsibilities to visitors of you site of all abilities.