Skip to main content

Spinner

A small indicator that work is in progress when the time is unknown.

In Multi-brand

See it live​

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

When to use it​

In Multi-brand: A payment in progress.

  • Use it when: Fetching a panel or syncing, a wait that is not the button itself.
  • Not when: A layout placeholder (skeleton), or known progress (progress).

Instead:

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 has a name such as Loading and is announced politely. undefined

Use it in code​

npx open-ds add spinner

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

Tokens it reads​

Spinner reads 1 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 Spinner's tokens to change Spinner 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
Spinner
Icon sizecomponent.spinner.icon-sizesize.iconvar(--spinner-icon-size)size.16:1rem