Skip to main content

Progress

How far a task has come.

In Dense data

See it live​

Start Storybook to see it live: npm run storybook
Live from StorybookOpen Progress in StorybookSee it in dark

When to use it​

In Dense data: A known amount of work, such as exporting many alerts. Not for table loads, which use skeletons.

  • Use it when: A known amount of work: an upload, steps of a form.
  • Not when: A wait of unknown length (spinner), or a layout placeholder (skeleton).

Instead:

  • Spinner: A wait of unknown length.
  • Skeleton: Content that has not arrived.

Words​

  • Lead with the object, then the state: "Alert 2041 contained."
  • Use numbers, not words for numbers.
  • One verb per button. No "please", no exclamation marks.
  • Use: Investigate, Filter, Assign, Escalated, Resolved. Avoid: Oops, Awesome, Please, Simply.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Cancel
  • content.action.destroy: Delete
  • content.action.retry: Retry
  • content.action.empty-action: Change filters

See Voice and tone for the whole voice.

Accessibility and keyboard​

Test before you ship:

  • It reports its value and has a name. undefined

Use it in code​

npx open-ds add progress

The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.

Tokens it reads​

Progress reads 3 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Progress's tokens to change Progress alone.

Changes with theme

Dense data decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.

PartIts token and the semantic it aliasesValue
Progress
Cornercomponent.progress.radiusradius.roundvar(--progress-radius)radius.full:9999px
Fill
Changes with theme		component.progress.backgroundcolor.action.primaryvar(--progress-background)Lightviolet.light.600:#4B3FD9Darkviolet.dark.600:#A9A3F6
Indicator
Fill
Changes with theme		component.progress.indicator.backgroundcolor.action.primaryvar(--progress-indicator-background)Lightviolet.light.600:#4B3FD9Darkviolet.dark.600:#A9A3F6