Carousel

Installation

Install the component via the CLI in one command.

npx shadcn@latest add @intentui/carousel

Composed components

Manual installation

Use this approach if you prefer to install and wire up the component yourself instead of using the CLI.

npm install react-aria-components embla-carousel-react @heroicons/react

Anatomy

import {
  Carousel,
  CarouselButton,
  CarouselContent,
  CarouselHandler,
  CarouselItem,
} from "@/components/ui/carousel"

<Carousel>
  <CarouselContent>
    <CarouselItem className="basis-1/2">Slide 1</CarouselItem>
    <CarouselItem className="basis-1/2">Slide 2</CarouselItem>
    <CarouselItem className="basis-1/2">Slide 3</CarouselItem>
  </CarouselContent>

  <CarouselHandler>
    <CarouselButton segment="previous" />
    <CarouselButton segment="next" />
  </CarouselHandler>
</Carousel>

Examples

Orientation

You can change the orientation of the carousel by using the orientation prop. The default is horizontal, but you can switch it to vertical.

Options

You want to loop, or align the carouse, don't worry, you can do it with the opts prop.

Autoplay

This a plugin by the embla-carousel it self, it's not included in the package, but you can install it to make sure the carousel autoplay.

npm install embla-carousel-autoplay

Once you install it, you can use it with the plugins prop.

Link

If you need a link in carousel item, it simple, add href to the CarouselItem.

<CarouselItem href="/path/to/page"/>

Component API

Carousel

The Carousel component is the root container for carousel state and layout.

CarouselButton

The CarouselButton component navigates to the previous or next carousel item.

CarouselContent

The CarouselContent component wraps the scrollable carousel track.

CarouselHandler

The CarouselHandler component renders the carousel control area.

CarouselItem

The CarouselItem component wraps one carousel slide.

See the React Aria and Embla Carousel API reference for the full API reference.