Skip to main content

Skeleton

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

In Content first

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 Content first: Article text while it loads.

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

  • Write to one person: "you", not "users".
  • Short sentences with room to breathe.
  • Explain why before asking for anything.
  • Use: Read, Save for later, You, Next issue. Avoid: Click here, Submit, Users, Content.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Not now
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Browse guides

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

Content first 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
Skeleton
Cornercomponent.skeleton.radiusradius.controlvar(--skeleton-radius)radius.8:0.5rem
Fill
Changes with theme		component.skeleton.backgroundcolor.surface.sunkenvar(--skeleton-background)Lightstone.light.100:#F6F2EADarkstone.dark.100:#2E2A24