Carousel
Slides that move left and right, one or a few at a time.
In Content first
See it live
npm run storybookWhen to use it
In Content first: A few images people browse for pleasure, where missing some is fine. Not for anything readers must see.
- 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
- 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: Savecontent.action.cancel: Not nowcontent.action.destroy: Removecontent.action.retry: Try againcontent.action.empty-action: Browse guides
See Voice and tone for the whole voice.
Accessibility and keyboard
| Keyboard | What happens | Not |
|---|---|---|
| undefined | Arrow 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.
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.
| Part | Its token and the semantic it aliases | Value |
|---|---|---|
| Item | ||
| Padding left | component.carousel.item.padding-leftcomponent-spacing-map.x4var(--carousel-item-padding-left) | space.24:1.5rem |
| Padding, top | component.carousel.item.padding-topcomponent-spacing-map.x4var(--carousel-item-padding-top) | space.24:1.5rem |
| Previous | ||
| Size | component.carousel.previous.sizesize.control.defaultvar(--carousel-previous-size) | size.48:3rem |
| Corner | component.carousel.previous.radiusradius.roundvar(--carousel-previous-radius) | radius.full:9999px |
| Next | ||
| Size | component.carousel.next.sizesize.control.defaultvar(--carousel-next-size) | size.48:3rem |
| Corner | component.carousel.next.radiusradius.roundvar(--carousel-next-radius) | radius.full:9999px |