Skip to main content

Skeleton

Placeholder shapes that match the final layout, so the page does not jump when content arrives.

In Multi-brand

See it live​

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

When to use it​

In Multi-brand: Plans and orders while they load.

  • Use it when: Lists, cards, dashboards and tables whose shape is known.
  • Not when: A wait with no layout (spinner), or a region that loaded empty (empty).

Instead:

  • Spinner: A wait with no layout.
  • Empty: Loaded, with nothing to show.

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:

  • The region says it is loading; the shapes themselves are hidden from screen readers. undefined

Use it in code​

npx open-ds add skeleton

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

Tokens it reads​

Skeleton reads 2 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 Skeleton's tokens to change Skeleton 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
Skeleton
Corner
Changes with theme		component.skeleton.radiusradius.controlvar(--skeleton-radius)Aster Lightradius.4:0.25remAster Darkradius.4:0.25remBirch Lightradius.12:0.75remBirch Darkradius.12:0.75remCoral Lightradius.999:9999pxCoral Darkradius.999:9999px
Fill
Changes with theme		component.skeleton.backgroundcolor.surface.sunkenvar(--skeleton-background)Aster Lightslate-deep.light.100:#F1F5F9Aster Darkslate-deep.dark.100:#1E293BBirch Lightslate-deep.light.100:#F1F5F9Birch Darkslate-deep.dark.100:#1E293BCoral Lightslate-deep.light.100:#F1F5F9Coral Darkslate-deep.dark.100:#1E293B