Skip to main content

Carousel

Slides that move left and right, one or a few at a time.

Left out of Accessible first People must finish the form, and a carousel suits content where missing some is fine. Content people must see does not belong in slides. Use instead: Card

See it live​

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

When to use it​

  • Use it when: A few images or items people browse for pleasure, where missing some is fine.
  • Not when: Content people must see: most never reach the later slides.

Instead:

  • Card: A grid shows every item at once.

Words​

  • Use common words. Explain any term you must use.
  • One idea per sentence. Put the action first.
  • Never blame the person.
  • Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.

The labels components use, from the voice tokens:

  • content.action.commit: Continue
  • content.action.cancel: Go back
  • content.action.destroy: Delete
  • content.action.retry: Try again
  • content.action.empty-action: Start a new application

See Voice and tone for the whole voice.

Accessibility and keyboard​

KeyboardWhat happensNot
undefinedArrow keys move between slides when the carousel has focus.undefined

Test before you ship:

  • Previous and next are buttons with names; nothing moves on its own without a pause control. undefined

Use it in code​

npx open-ds add carousel

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

Tokens it reads​

Carousel reads 6 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 Carousel's tokens to change Carousel alone.

Changes with theme

Accessible 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
Item
Padding leftcomponent.carousel.item.padding-leftcomponent-spacing-map.x4var(--carousel-item-padding-left)space.28:1.75rem
Padding, topcomponent.carousel.item.padding-topcomponent-spacing-map.x4var(--carousel-item-padding-top)space.28:1.75rem
Previous
Sizecomponent.carousel.previous.sizesize.control.defaultvar(--carousel-previous-size)size.52:3.25rem
Cornercomponent.carousel.previous.radiusradius.roundvar(--carousel-previous-radius)radius.full:9999px
Next
Sizecomponent.carousel.next.sizesize.control.defaultvar(--carousel-next-size)size.52:3.25rem
Cornercomponent.carousel.next.radiusradius.roundvar(--carousel-next-radius)radius.full:9999px