Skip to main content

Progress

How far a task has come.

In Multi-brand

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 Multi-brand: A sign-up split into known steps, showing how far the customer has come. Not for a payment in progress; spinner covers that.

  • 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​

  • Shared structure: object, state, next step.
  • Brand tone lives in headlines and marketing copy, not in errors.
  • Errors and confirmations read the same in every brand.
  • Use: Get started, Plan, Order. Avoid: Brand-specific words in errors, Jargon.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Cancel
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Get started

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

Multi-brand decides what changes when you switch theme. Here a switch changes colors, type and shape, so the marked rows differ between its brands and 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)Aster Lightteal.light.600:#0F766EAster Darkteal.dark.600:#7FCFC6Birch Lightpurple.light.600:#6D28D9Birch Darkpurple.dark.600:#B79DF7Coral Lightorange.light.600:#C2410CCoral Darkorange.dark.600:#F7A67F
Indicator
Fill
Changes with theme		component.progress.indicator.backgroundcolor.action.primaryvar(--progress-indicator-background)Aster Lightteal.light.600:#0F766EAster Darkteal.dark.600:#7FCFC6Birch Lightpurple.light.600:#6D28D9Birch Darkpurple.dark.600:#B79DF7Coral Lightorange.light.600:#C2410CCoral Darkorange.dark.600:#F7A67F