Data and utilities · stable · MIT

Carousel

Controlled or uncontrolled labelled slides with finite or looping movement.

Install editable source

Add Carousel

Base UI / canonicalnpx shadcn@latest add https://gummyui.dev/r/gummy-carousel.json

No package dependency beyond React. Shared Gummy material is resolved automatically.

Behavior contract

Semantics before surface

Semantics

A labelled carousel region containing inert inactive slide groups.

Keyboard

Logical arrows move; Home and End jump to the first or last slide.

System support

Light and dark themes, logical RTL layout, reduced motion, responsive content, and forwarded public refs.

Source-derived reference

Anatomy and public API

Exported anatomy

These public React parts are read directly from the canonical source during the documentation build.

GummyCarousel
GummyCarouselContent
GummyCarouselIndicators
GummyCarouselItem
GummyCarouselNext
GummyCarouselPrevious

Prop contracts

`GummyCarouselItemProps`

Composes React.HTMLAttributes<HTMLDivElement> & { index: number; label?: string; }

`GummyCarouselProps`

Composes Omit<React.HTMLAttributes<HTMLDivElement>, "onChange" | "dir"> & { itemCount: number; index?: number; defaultIndex?: number; onIndexChange?: (index: number) => void; loop?: boolean; orientation?: "horizontal" | "vertical"; direction?: "ltr" | "rtl"; label?: string; }

Troubleshooting

Check behavior before surface.

If the material is missing, confirm the registry-installed shared and component CSS files are imported once.
If interaction differs, preserve this contract: Logical arrows move; Home and End jump to the first or last slide.
If assistive output differs, preserve this semantic foundation: A labelled carousel region containing inert inactive slide groups.
If dark, RTL, or reduced-motion behavior is missing, verify the nearest theme, direction, and media-query boundaries rather than adding page-local overrides.

Live product source

Inspect the canonical states

The Component Lab exercises real source across default, focus, disabled, responsive, dark, reduced-motion, and RTL contexts.

Open the live Component Lab

Interactive inspection

Try Carousel in context

Load the real component preview when you are ready to interact with its responsive, theme, and direction controls.

Editable source

Read before you install

Canonical Base UI or native source

The registry payload stays off the initial page request.