# Carousel

A swipeable track of slides with buttons, dots and optional autoplay, built on Embla Carousel.

Carousel is an open-source component from suiss/ui for React, React Native, SwiftUI and Jetpack Compose. The @esuiss/ui CLI copies its source into your project, so you own the code.

Source: https://ui.suiss.app/docs/components/carousel

**React**

**Example**

```tsx
import { Card, CardContent } from "@/components/ui/card"
import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselNext,
  CarouselPrevious,
} from "@/components/ui/carousel"

const slides = [1, 2, 3, 4, 5]

export default function CarouselDemo() {
  return (
    <div className="mx-12 w-72">
      <Carousel orientation="horizontal">
        <CarouselContent>
          {slides.map((slide) => (
            <CarouselItem key={slide}>
              <Card>
                <CardContent className="flex aspect-square items-center justify-center">
                  <span className="text-4xl font-semibold">{slide}</span>
                </CardContent>
              </Card>
            </CarouselItem>
          ))}
        </CarouselContent>
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </div>
  )
}
```

Carousel is built on `embla-carousel-react`. A `Carousel` root holds a `CarouselContent` track whose children are `CarouselItem` slides. Add `CarouselPrevious` and `CarouselNext` to page through slides; on their own they float outside the track's edges. To lay controls out in a row below the track instead, place them in a `CarouselControls` container, along with `CarouselDots` for per-slide indicators and `CarouselPlayButton` for autoplay.

Use a carousel for featured content, product shelves, testimonials and galleries where people browse a set of peers one at a time. For content everyone must see, prefer a static layout.

## Installation

### CLI

```bash title="Terminal"
npx shadcn@latest add @esuiss/carousel
```

Works in any project with a `components.json`. See [Installation](https://ui.suiss.app/docs/installation#add-components) for the one-line registry setup. Or use the suiss/ui CLI:

```bash title="Terminal"
npx @esuiss/ui@latest add carousel
```

### Manual

1. Install the dependencies and add the [`cn` helper](https://ui.suiss.app/docs/installation#the-cn-helper):

```bash title="Terminal"
npm install @phosphor-icons/react embla-carousel-react
```

2. Add the pieces it builds on: [Button](https://ui.suiss.app/docs/components/button), [Direction](https://ui.suiss.app/docs/components/direction).

3. Copy the source into `components/ui/carousel.tsx`:

```tsx title="components/ui/carousel.tsx"
"use client"

import {
  CaretLeftIcon,
  CaretRightIcon,
  PauseIcon,
  PlayIcon,
} from "@phosphor-icons/react"
import useEmblaCarousel, {
  type UseEmblaCarouselType,
} from "embla-carousel-react"
import * as React from "react"
import { Button } from "@/components/ui/button"
import { useDirection } from "@/components/ui/direction"
import { cn } from "@/lib/utils"

type CarouselApi = UseEmblaCarouselType[1]

const STEP_KEYS = {
  vertical: ["ArrowUp", "ArrowDown"],
  ltr: ["ArrowLeft", "ArrowRight"],
  rtl: ["ArrowRight", "ArrowLeft"],
} as const
type UseCarouselParameters = Parameters<typeof useEmblaCarousel>
type CarouselOptions = UseCarouselParameters[0]
type CarouselPlugin = UseCarouselParameters[1]

type CarouselProps = {
  opts?: CarouselOptions
  plugins?: CarouselPlugin
  orientation?: "horizontal" | "vertical"
  setApi?: (api: CarouselApi) => void
  autoplay?: boolean | number
}

type CarouselAutoplay = {
  enabled: boolean
  delay: number
  playing: boolean
  running: boolean
  setPlaying: (playing: boolean) => void
  elapsed: () => number
}

type CarouselContextProps = {
  carouselRef: ReturnType<typeof useEmblaCarousel>[0]
  api: ReturnType<typeof useEmblaCarousel>[1]
  scrollPrev: () => void
  scrollNext: () => void
  canScrollPrev: boolean
  canScrollNext: boolean
  selectedIndex: number
  autoplay: CarouselAutoplay
} & Omit<CarouselProps, "autoplay">

const CarouselContext = React.createContext<CarouselContextProps | null>(null)
const CarouselOrientationContext = React.createContext<
  "horizontal" | "vertical"
>("horizontal")

function useCarousel() {
  const context = React.useContext(CarouselContext)

  if (!context) {
    throw new Error("useCarousel must be used within a <Carousel />")
  }

  return context
}

const INTERACTIVE =
  "input, textarea, select, [contenteditable]:not([contenteditable=false]), [role=slider], [role=radio], [role=spinbutton], [role=listbox], [role=combobox], [role=textbox], [role=tablist], [role=menu], [role=grid]"

function keepControlFocus(
  root: HTMLDivElement | null,
  api: NonNullable<CarouselApi>
) {
  const active = document.activeElement
  if (!root || !(active instanceof HTMLElement) || !root.contains(active)) {
    return
  }
  const slot = active.dataset.slot
  const stranded =
    (slot === "carousel-previous" && !api.canScrollPrev()) ||
    (slot === "carousel-next" && !api.canScrollNext())
  if (!stranded) return
  const other = root.querySelector<HTMLButtonElement>(
    slot === "carousel-next"
      ? "[data-slot=carousel-previous]"
      : "[data-slot=carousel-next]"
  )
  if (other && !other.disabled) other.focus()
  else root.focus()
}

function Carousel({
  orientation = "horizontal",
  opts,
  setApi,
  plugins,
  autoplay = false,
  className,
  children,
  onPointerEnter,
  onPointerLeave,
  onFocus,
  onBlur,
  ref,
  ...props
}: React.ComponentProps<"div"> & CarouselProps) {
  const rootRef = React.useRef<HTMLDivElement | null>(null)
  const direction = useDirection()
  const [carouselRef, api] = useEmblaCarousel(
    {
      direction,
      ...opts,
      axis: orientation === "horizontal" ? "x" : "y",
    },
    plugins
  )
  const [canScrollPrev, setCanScrollPrev] = React.useState(false)
  const [canScrollNext, setCanScrollNext] = React.useState(false)
  const [selectedIndex, setSelectedIndex] = React.useState(0)
  const [playing, setPlaying] = React.useState(Boolean(autoplay))
  const [hovered, setHovered] = React.useState(false)
  const [focused, setFocused] = React.useState(false)
  const [hidden, setHidden] = React.useState(false)
  const delay = typeof autoplay === "number" ? autoplay : 5000
  const running =
    Boolean(autoplay) && playing && !hovered && !focused && !hidden

  const onSelect = React.useCallback((api: CarouselApi) => {
    if (!api) return
    keepControlFocus(rootRef.current, api)
    setCanScrollPrev(api.canScrollPrev())
    setCanScrollNext(api.canScrollNext())
    setSelectedIndex(api.selectedScrollSnap())
  }, [])

  const scrollPrev = React.useCallback(() => {
    api?.scrollPrev()
  }, [api])

  const scrollNext = React.useCallback(() => {
    api?.scrollNext()
  }, [api])

  const handleKeyDown = React.useCallback(
    (event: React.KeyboardEvent<HTMLDivElement>) => {
      if (event.target instanceof Element && event.target.closest(INTERACTIVE))
        return
      const [back, forward] =
        STEP_KEYS[orientation === "vertical" ? "vertical" : direction]
      if (event.key === back) {
        event.preventDefault()
        scrollPrev()
      } else if (event.key === forward) {
        event.preventDefault()
        scrollNext()
      }
    },
    [direction, orientation, scrollPrev, scrollNext]
  )

  React.useEffect(() => {
    if (!autoplay) return
    if (window.matchMedia("(prefers-reduced-motion: reduce)").matches) {
      setPlaying(false)
    }
    const update = () => setHidden(document.visibilityState === "hidden")
    update()
    document.addEventListener("visibilitychange", update)
    return () => document.removeEventListener("visibilitychange", update)
  }, [autoplay])

  const remaining = React.useRef({ index: 0, time: delay })
  const elapsed = React.useCallback(
    () =>
      remaining.current.index === selectedIndex
        ? delay - remaining.current.time
        : 0,
    [selectedIndex, delay]
  )

  React.useEffect(() => {
    if (!api || !running) return
    const index = selectedIndex
    if (remaining.current.index !== index) {
      remaining.current = { index, time: delay }
    }
    const start = performance.now()
    const timer = window.setTimeout(() => {
      if (api.selectedScrollSnap() !== index) return
      remaining.current = { index: -1, time: delay }
      if (api.canScrollNext()) api.scrollNext()
      else api.scrollTo(0)
    }, remaining.current.time)
    return () => {
      window.clearTimeout(timer)
      if (remaining.current.index === index) {
        remaining.current.time = Math.max(
          0,
          remaining.current.time - (performance.now() - start)
        )
      }
    }
  }, [api, running, selectedIndex, delay])

  React.useEffect(() => {
    if (!api || !setApi) return
    setApi(api)
  }, [api, setApi])

  React.useEffect(() => {
    if (!api) return
    onSelect(api)
    api.on("reInit", onSelect)
    api.on("select", onSelect)

    return () => {
      api?.off("select", onSelect)
      api?.off("reInit", onSelect)
    }
  }, [api, onSelect])

  return (
    <CarouselContext.Provider
      value={{
        carouselRef,
        api: api,
        opts,
        orientation:
          orientation || (opts?.axis === "y" ? "vertical" : "horizontal"),
        scrollPrev,
        scrollNext,
        canScrollPrev,
        canScrollNext,
        selectedIndex,
        autoplay: {
          enabled: Boolean(autoplay),
          delay,
          playing,
          running,
          setPlaying,
          elapsed,
        },
      }}
    >
      <div
        ref={(node) => {
          rootRef.current = node
          if (typeof ref === "function") return ref(node)
          if (ref) ref.current = node
        }}
        tabIndex={-1}
        onKeyDownCapture={handleKeyDown}
        className={cn("relative outline-none", className)}
        role="region"
        aria-roledescription="carousel"
        data-slot="carousel"
        data-playing={running ? "" : undefined}
        onPointerEnter={(event) => {
          if (event.pointerType === "mouse") setHovered(true)
          onPointerEnter?.(event)
        }}
        onPointerLeave={(event) => {
          setHovered(false)
          onPointerLeave?.(event)
        }}
        onFocus={(event) => {
          if (event.target.matches(":focus-visible")) setFocused(true)
          onFocus?.(event)
        }}
        onBlur={(event) => {
          if (!event.currentTarget.contains(event.relatedTarget)) {
            setFocused(false)
          }
          onBlur?.(event)
        }}
        {...props}
      >
        <CarouselOrientationContext.Provider
          value={orientation === "vertical" ? "vertical" : "horizontal"}
        >
          {children}
        </CarouselOrientationContext.Provider>
      </div>
    </CarouselContext.Provider>
  )
}

function CarouselContent({ className, ...props }: React.ComponentProps<"div">) {
  const { carouselRef, orientation } = useCarousel()

  return (
    <div
      ref={carouselRef}
      className="overflow-hidden"
      data-slot="carousel-content"
    >
      <div
        className={cn(
          "flex",
          orientation === "horizontal" ? "-ms-4" : "-mt-4 flex-col",
          className
        )}
        {...props}
      />
    </div>
  )
}

function CarouselItem({ className, ...props }: React.ComponentProps<"div">) {
  const orientation = React.useContext(CarouselOrientationContext)

  return (
    <div
      role="group"
      aria-roledescription="slide"
      data-slot="carousel-item"
      className={cn(
        "min-w-0 shrink-0 grow-0 basis-full",
        orientation === "horizontal" ? "ps-4" : "pt-4",
        className
      )}
      {...props}
    />
  )
}

function CarouselPrevious({
  className,
  variant = "secondary",
  size = "icon",
  ...props
}: React.ComponentProps<typeof Button>) {
  const { orientation, scrollPrev, canScrollPrev } = useCarousel()

  return (
    <Button
      data-slot="carousel-previous"
      variant={variant}
      size={size}
      className={cn(
        "absolute touch-manipulation rounded-full in-data-[slot=carousel-controls]:static in-data-[slot=carousel-controls]:m-0 in-data-[slot=carousel-controls]:translate-x-0 in-data-[slot=carousel-controls]:rotate-0",
        orientation === "horizontal"
          ? "inset-y-0 -inset-s-12 my-auto"
          : "-top-12 inset-s-1/2 -translate-x-1/2 rtl:translate-x-1/2 rotate-90",
        className
      )}
      disabled={!canScrollPrev}
      onClick={scrollPrev}
      {...props}
    >
      <CaretLeftIcon
        className={
          orientation === "horizontal"
            ? "rtl:rotate-180"
            : "rtl:in-data-[slot=carousel-controls]:rotate-180"
        }
      />
      <span className="sr-only">Previous slide</span>
    </Button>
  )
}

function CarouselNext({
  className,
  variant = "secondary",
  size = "icon",
  ...props
}: React.ComponentProps<typeof Button>) {
  const { orientation, scrollNext, canScrollNext } = useCarousel()

  return (
    <Button
      data-slot="carousel-next"
      variant={variant}
      size={size}
      className={cn(
        "absolute touch-manipulation rounded-full in-data-[slot=carousel-controls]:static in-data-[slot=carousel-controls]:m-0 in-data-[slot=carousel-controls]:translate-x-0 in-data-[slot=carousel-controls]:rotate-0",
        orientation === "horizontal"
          ? "inset-y-0 -inset-e-12 my-auto"
          : "-bottom-12 inset-s-1/2 -translate-x-1/2 rtl:translate-x-1/2 rotate-90",
        className
      )}
      disabled={!canScrollNext}
      onClick={scrollNext}
      {...props}
    >
      <CaretRightIcon
        className={
          orientation === "horizontal"
            ? "rtl:rotate-180"
            : "rtl:in-data-[slot=carousel-controls]:rotate-180"
        }
      />
      <span className="sr-only">Next slide</span>
    </Button>
  )
}

function CarouselControls({
  className,
  ...props
}: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="carousel-controls"
      className={cn("mt-6 flex items-center gap-3", className)}
      {...props}
    />
  )
}

function CarouselDots({
  className,
  variant = "default",
  ...props
}: React.ComponentProps<"div"> & { variant?: "default" | "plain" }) {
  const { api, selectedIndex, autoplay } = useCarousel()
  const [count, setCount] = React.useState(0)
  const [fill, setFill] = React.useState<HTMLSpanElement | null>(null)
  const [progress, setProgress] = React.useState<Animation | null>(null)

  React.useEffect(() => {
    if (!api) return
    const update = () => setCount(api.scrollSnapList().length)
    update()
    api.on("reInit", update)
    return () => {
      api.off("reInit", update)
    }
  }, [api])

  React.useEffect(() => {
    if (!fill || !autoplay.enabled) return
    if (!autoplay.playing) {
      fill.style.transform = "scaleX(1)"
      setProgress(null)
      return
    }
    fill.style.transform = ""
    const animation = fill.animate(
      [{ transform: "scaleX(0)" }, { transform: "scaleX(1)" }],
      { duration: autoplay.delay, easing: "linear", fill: "forwards" }
    )
    animation.currentTime = autoplay.elapsed()
    setProgress(animation)
    return () => animation.cancel()
  }, [
    fill,
    autoplay.enabled,
    autoplay.playing,
    autoplay.delay,
    autoplay.elapsed,
  ])

  React.useEffect(() => {
    if (
      !progress ||
      (progress.playState !== "running" && progress.playState !== "paused")
    )
      return
    if (autoplay.running) progress.play()
    else progress.pause()
  }, [progress, autoplay.running])

  return (
    <div
      data-slot="carousel-dots"
      data-variant={variant}
      data-autoplay={autoplay.enabled ? "" : undefined}
      className={cn(
        "group/carousel-dots flex h-9 items-center gap-4 rounded-full bg-secondary px-4 backdrop-blur-xl data-[variant=plain]:bg-transparent data-[variant=plain]:px-0 data-[variant=plain]:backdrop-blur-none",
        className
      )}
      {...props}
    >
      {Array.from({ length: count }, (_, position) => position).map((index) => (
        <button
          key={index}
          type="button"
          aria-label={`Go to slide ${index + 1}`}
          aria-current={index === selectedIndex ? "true" : undefined}
          data-active={index === selectedIndex ? "" : undefined}
          onClick={() => api?.scrollTo(index)}
          className="relative h-2 w-2 shrink-0 cursor-pointer rounded-full bg-muted-foreground transition-[width,background-color] duration-500 ease-[cubic-bezier(0.32,0.72,0,1)] outline-none after:absolute after:-inset-2 after:content-[''] hover:bg-muted-foreground focus-visible:ring-3 focus-visible:ring-ring/50 data-active:w-6 data-active:bg-foreground group-data-autoplay/carousel-dots:data-active:bg-muted-foreground motion-reduce:transition-none"
        >
          {index === selectedIndex && autoplay.enabled && (
            <span
              aria-hidden="true"
              className="absolute inset-0 overflow-hidden rounded-full"
            >
              <span
                ref={setFill}
                className="absolute inset-0 origin-left rounded-full bg-foreground rtl:origin-right"
              />
            </span>
          )}
        </button>
      ))}
    </div>
  )
}

function CarouselPlayButton({
  className,
  variant = "secondary",
  size = "icon-sm",
  ...props
}: React.ComponentProps<typeof Button>) {
  const { autoplay } = useCarousel()
  if (!autoplay.enabled) return null

  return (
    <Button
      data-slot="carousel-play-button"
      variant={variant}
      size={size}
      aria-label={autoplay.playing ? "Pause slideshow" : "Play slideshow"}
      className={cn("touch-manipulation rounded-full", className)}
      onClick={() => autoplay.setPlaying(!autoplay.playing)}
      {...props}
    >
      {autoplay.playing ? (
        <PauseIcon className="fill-current" />
      ) : (
        <PlayIcon className="fill-current" />
      )}
    </Button>
  )
}

export {
  Carousel,
  type CarouselApi,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
  CarouselPrevious,
  useCarousel,
}
```

4. Update the import paths to match your project.

## Usage

```tsx
import { Carousel, CarouselContent, CarouselItem, CarouselPrevious, CarouselNext, CarouselControls, CarouselDots, CarouselPlayButton } from "@/components/ui/carousel"
```

```tsx
<Carousel orientation="horizontal">
  <CarouselContent>
    {slides.map((slide) => (
      <CarouselItem key={slide}>
        <Card>
          <CardContent className="flex aspect-square items-center justify-center">
            <span className="text-4xl font-semibold">{slide}</span>
          </CardContent>
        </Card>
      </CarouselItem>
    ))}
  </CarouselContent>
  <CarouselPrevious />
  <CarouselNext />
</Carousel>
```

`Carousel` accepts `opts` (Embla options such as `align`, `loop` and `dragFree`), `plugins`, `orientation` (`horizontal` or `vertical`) and `setApi`, which receives the Embla API so you can read or drive the carousel from outside. The scroll direction follows the surrounding `DirectionProvider`.

Set the width of each slide with a `basis-*` class on `CarouselItem`, for example `basis-1/2` to show two at a time. The track uses negative margin and slides use start padding for gutters; adjust both together, as in `-ms-3` with `ps-3`.

Set `autoplay` to `true` for a 5-second interval, or to a number of milliseconds. Autoplay pauses while the pointer hovers the carousel, while it has keyboard focus, and while the page is hidden, and starts paused when the user prefers reduced motion. `CarouselPlayButton` renders only when autoplay is enabled, and the active dot fills as a progress bar.

Use the `useCarousel` hook inside a `Carousel` to build custom controls.

## Examples

### Multiple items

Shows two slides at a time with `basis-1/2`.

**Example**

```tsx
import { Card, CardContent } from "@/components/ui/card"
import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselNext,
  CarouselPrevious,
} from "@/components/ui/carousel"

const slides = [1, 2, 3, 4, 5]

export default function CarouselMultipleItems() {
  return (
    <div className="mx-12 w-72">
      <Carousel orientation="horizontal" opts={{ align: "start" }}>
        <CarouselContent>
          {slides.map((slide) => (
            <CarouselItem key={slide} className="basis-1/2">
              <Card size="sm">
                <CardContent className="flex aspect-square items-center justify-center">
                  <span className="text-3xl font-semibold">{slide}</span>
                </CardContent>
              </Card>
            </CarouselItem>
          ))}
        </CarouselContent>
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </div>
  )
}
```

### Loop

Wraps from the last slide back to the first with `opts={{ loop: true }}`.

**Example**

```tsx
import { Card, CardContent } from "@/components/ui/card"
import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselNext,
  CarouselPrevious,
} from "@/components/ui/carousel"

const slides = [1, 2, 3, 4, 5]

export default function CarouselLoop() {
  return (
    <div className="mx-12 w-72">
      <Carousel orientation="horizontal" opts={{ loop: true }}>
        <CarouselContent>
          {slides.map((slide) => (
            <CarouselItem key={slide}>
              <Card>
                <CardContent className="flex aspect-square items-center justify-center">
                  <span className="text-4xl font-semibold">{slide}</span>
                </CardContent>
              </Card>
            </CarouselItem>
          ))}
        </CarouselContent>
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </div>
  )
}
```

### Vertical

Scrolls vertically, with the buttons above and below the track.

**Example**

```tsx
import { Card, CardContent } from "@/components/ui/card"
import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselNext,
  CarouselPrevious,
} from "@/components/ui/carousel"

const slides = [1, 2, 3, 4, 5]

export default function CarouselVertical() {
  return (
    <div className="mx-12 w-72">
      <div className="my-12">
        <Carousel orientation="vertical" opts={{ align: "start" }}>
          <CarouselContent className="h-64">
            {slides.map((slide) => (
              <CarouselItem key={slide} className="basis-1/2">
                <Card size="sm" className="h-full justify-center">
                  <CardContent className="flex items-center justify-center">
                    <span className="text-3xl font-semibold">{slide}</span>
                  </CardContent>
                </Card>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselPrevious />
          <CarouselNext />
        </Carousel>
      </div>
    </div>
  )
}
```

### Featured

Large cards that peek at the next slide, with plain dots below.

**Example**

```tsx
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselPlayButton,
} from "@/components/ui/carousel"

const picks = [
  {
    eyebrow: "Today's pick",
    title: "Weekend breakfast",
    tint: "from-orange-500 to-red-500",
  },
  {
    eyebrow: "New",
    title: "Grilled meatballs",
    tint: "from-red-500 to-pink-500",
  },
  {
    eyebrow: "Chef's special",
    title: "Lentil soup",
    tint: "from-green-500 to-teal-500",
  },
  {
    eyebrow: "Dessert",
    title: "Künefe",
    tint: "from-purple-500 to-indigo-500",
  },
]

export default function CarouselFeatured() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-sm">
        <Carousel orientation="horizontal" opts={{ align: "start" }}>
          <CarouselContent>
            {picks.map((pick) => (
              <CarouselItem key={pick.title} className="basis-[88%]">
                <div
                  className={`relative isolate flex aspect-4/5 flex-col gap-1 overflow-hidden rounded-3xl bg-linear-to-br p-5 text-white before:absolute before:inset-0 before:-z-10 before:bg-linear-to-b before:from-black/45 before:to-black/10 ${pick.tint}`}
                >
                  <p className="text-xs font-semibold uppercase">
                    {pick.eyebrow}
                  </p>
                  <p className="text-2xl font-bold tracking-tight">
                    {pick.title}
                  </p>
                </div>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselControls className="mt-4 justify-center">
            <CarouselDots variant="plain" />
            <CarouselPlayButton variant="ghost" />
          </CarouselControls>
        </Carousel>
      </div>
    </div>
  )
}
```

### Spotlight

A looping hero with dots and a next button in a centered control bar.

**Example**

```tsx
import { Button } from "@/components/ui/button"
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
} from "@/components/ui/carousel"

const features = [
  {
    eyebrow: "Point of sale",
    title: "Take orders at the table.",
    tint: "from-blue-500 to-indigo-500",
  },
  {
    eyebrow: "Kitchen",
    title: "Every ticket, right on time.",
    tint: "from-orange-500 to-red-500",
  },
  {
    eyebrow: "Reservations",
    title: "A full room, every night.",
    tint: "from-green-500 to-teal-500",
  },
  {
    eyebrow: "Analytics",
    title: "Know what sells.",
    tint: "from-purple-500 to-pink-500",
  },
  {
    eyebrow: "Payments",
    title: "Split the bill in seconds.",
    tint: "from-cyan-500 to-blue-500",
  },
]

export default function CarouselSpotlight() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-md">
        <Carousel orientation="horizontal" opts={{ loop: true }}>
          <CarouselContent>
            {features.slice(0, 3).map((feature) => (
              <CarouselItem key={feature.title}>
                <div className="flex aspect-10/7 flex-col items-center justify-center gap-3 rounded-3xl bg-muted p-8 text-center">
                  <p className="text-3xl font-bold tracking-tight">
                    Hestia POS
                  </p>
                  <p className="text-muted-foreground">{feature.title}</p>
                  <Button
                    size="sm"
                    className="mt-2 bg-foreground text-background hover:bg-foreground/85"
                  >
                    Learn more
                  </Button>
                </div>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselControls className="justify-center">
            <CarouselDots />
            <CarouselPlayButton />
            {<CarouselNext size="icon-sm" />}
          </CarouselControls>
        </Carousel>
      </div>
    </div>
  )
}
```

### Shelf

A drag-free product shelf with no visible buttons.

**Example**

```tsx
import { CaretRightIcon } from "@phosphor-icons/react"
import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselPlayButton,
} from "@/components/ui/carousel"

const popular = [
  {
    name: "Breakfast platter",
    price: "₺620",
    tint: "from-orange-500 to-red-500",
  },
  {
    name: "Grilled meatballs",
    price: "₺280",
    tint: "from-red-500 to-pink-500",
  },
  { name: "Menemen", price: "₺160", tint: "from-yellow-500 to-orange-500" },
  { name: "Lentil soup", price: "₺90", tint: "from-green-500 to-teal-500" },
  { name: "Künefe", price: "₺160", tint: "from-purple-500 to-indigo-500" },
]

export default function CarouselShelf() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-md">
        <Carousel
          orientation="horizontal"
          opts={{ align: "start", dragFree: true }}
        >
          <div className="mb-3 flex items-center justify-between">
            <a
              href="#popular"
              className="flex items-center gap-1 text-xl font-bold tracking-tight"
            >
              Popular
              <CaretRightIcon className="size-4" />
            </a>
            <div className="flex items-center gap-3">
              <CarouselPlayButton variant="ghost" />
              <a href="#popular-all" className="text-primary">
                See all
              </a>
            </div>
          </div>
          <CarouselContent className="-ms-3">
            {popular.map((item) => (
              <CarouselItem key={item.name} className="basis-2/5 ps-3">
                <div
                  className={`aspect-square rounded-2xl bg-linear-to-br ${item.tint}`}
                />
                <p className="mt-2 truncate text-sm font-semibold">
                  {item.name}
                </p>
                <p className="text-xs text-muted-foreground tabular-nums">
                  {item.price}
                </p>
              </CarouselItem>
            ))}
          </CarouselContent>
        </Carousel>
      </div>
    </div>
  )
}
```

### Testimonials

Quotes with dots and large previous and next buttons in a control row.

**Example**

```tsx
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
  CarouselPrevious,
} from "@/components/ui/carousel"

const quotes = [
  { quote: "The checkout line is half as long.", author: "Ayşe Y. · Kadıköy" },
  {
    quote: "The kitchen finally keeps up on Fridays.",
    author: "Mert K. · Beşiktaş",
  },
  { quote: "Splitting the bill takes seconds now.", author: "Deniz A. · Moda" },
]

export default function CarouselTestimonials() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-md rounded-3xl bg-muted p-8">
        <Carousel orientation="horizontal">
          <CarouselContent>
            {quotes.map((item) => (
              <CarouselItem key={item.quote}>
                <blockquote className="flex min-h-28 flex-col gap-3">
                  <p className="text-2xl font-bold tracking-tight">
                    “{item.quote}”
                  </p>
                  <footer className="text-muted-foreground">
                    {item.author}
                  </footer>
                </blockquote>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselControls className="justify-between">
            <div className="flex items-center gap-2">
              <CarouselPlayButton variant="ghost" />
              <CarouselDots variant="plain" />
            </div>
            <div className="flex gap-3">
              <CarouselPrevious size="icon-lg" />
              <CarouselNext size="icon-lg" />
            </div>
          </CarouselControls>
        </Carousel>
      </div>
    </div>
  )
}
```

### Gallery

Tall cards with controls aligned to the end below the track.

**Example**

```tsx
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselItem,
  CarouselNext,
  CarouselPrevious,
} from "@/components/ui/carousel"

const features = [
  {
    eyebrow: "Point of sale",
    title: "Take orders at the table.",
    tint: "from-blue-500 to-indigo-500",
  },
  {
    eyebrow: "Kitchen",
    title: "Every ticket, right on time.",
    tint: "from-orange-500 to-red-500",
  },
  {
    eyebrow: "Reservations",
    title: "A full room, every night.",
    tint: "from-green-500 to-teal-500",
  },
  {
    eyebrow: "Analytics",
    title: "Know what sells.",
    tint: "from-purple-500 to-pink-500",
  },
  {
    eyebrow: "Payments",
    title: "Split the bill in seconds.",
    tint: "from-cyan-500 to-blue-500",
  },
]

export default function CarouselGallery() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <Carousel orientation="horizontal" opts={{ align: "start" }}>
        <CarouselContent>
          {features.map((feature) => (
            <CarouselItem
              key={feature.title}
              className="basis-4/5 sm:basis-2/5"
            >
              <div
                className={`relative isolate flex aspect-3/4 flex-col gap-2 overflow-hidden rounded-3xl bg-linear-to-b p-7 text-white before:absolute before:inset-0 before:-z-10 before:bg-black/35 ${feature.tint}`}
              >
                <p className="text-sm font-semibold">{feature.eyebrow}</p>
                <p className="text-2xl font-semibold">{feature.title}</p>
              </div>
            </CarouselItem>
          ))}
        </CarouselContent>
        <CarouselControls className="justify-end">
          <CarouselPrevious />
          <CarouselNext />
        </CarouselControls>
      </Carousel>
    </div>
  )
}
```

### Featured autoplay

The featured layout advancing every four seconds.

**Example**

```tsx
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselPlayButton,
} from "@/components/ui/carousel"

const picks = [
  {
    eyebrow: "Today's pick",
    title: "Weekend breakfast",
    tint: "from-orange-500 to-red-500",
  },
  {
    eyebrow: "New",
    title: "Grilled meatballs",
    tint: "from-red-500 to-pink-500",
  },
  {
    eyebrow: "Chef's special",
    title: "Lentil soup",
    tint: "from-green-500 to-teal-500",
  },
  {
    eyebrow: "Dessert",
    title: "Künefe",
    tint: "from-purple-500 to-indigo-500",
  },
]

export default function CarouselFeaturedAutoplay() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-sm">
        <Carousel
          orientation="horizontal"
          opts={{ align: "start", loop: true }}
          autoplay={4000}
        >
          <CarouselContent>
            {picks.map((pick) => (
              <CarouselItem key={pick.title} className="basis-[88%]">
                <div
                  className={`relative isolate flex aspect-4/5 flex-col gap-1 overflow-hidden rounded-3xl bg-linear-to-br p-5 text-white before:absolute before:inset-0 before:-z-10 before:bg-linear-to-b before:from-black/45 before:to-black/10 ${pick.tint}`}
                >
                  <p className="text-xs font-semibold uppercase">
                    {pick.eyebrow}
                  </p>
                  <p className="text-2xl font-bold tracking-tight">
                    {pick.title}
                  </p>
                </div>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselControls className="mt-4 justify-center">
            <CarouselDots variant="plain" />
            <CarouselPlayButton variant="ghost" />
          </CarouselControls>
        </Carousel>
      </div>
    </div>
  )
}
```

### Spotlight autoplay

The spotlight layout with autoplay and a pause button in place of the next button.

**Example**

```tsx
import { Button } from "@/components/ui/button"
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
} from "@/components/ui/carousel"

const features = [
  {
    eyebrow: "Point of sale",
    title: "Take orders at the table.",
    tint: "from-blue-500 to-indigo-500",
  },
  {
    eyebrow: "Kitchen",
    title: "Every ticket, right on time.",
    tint: "from-orange-500 to-red-500",
  },
  {
    eyebrow: "Reservations",
    title: "A full room, every night.",
    tint: "from-green-500 to-teal-500",
  },
  {
    eyebrow: "Analytics",
    title: "Know what sells.",
    tint: "from-purple-500 to-pink-500",
  },
  {
    eyebrow: "Payments",
    title: "Split the bill in seconds.",
    tint: "from-cyan-500 to-blue-500",
  },
]

export default function CarouselSpotlightAutoplay() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-md">
        <Carousel orientation="horizontal" opts={{ loop: true }} autoplay>
          <CarouselContent>
            {features.slice(0, 3).map((feature) => (
              <CarouselItem key={feature.title}>
                <div className="flex aspect-10/7 flex-col items-center justify-center gap-3 rounded-3xl bg-muted p-8 text-center">
                  <p className="text-3xl font-bold tracking-tight">
                    Hestia POS
                  </p>
                  <p className="text-muted-foreground">{feature.title}</p>
                  <Button
                    size="sm"
                    className="mt-2 bg-foreground text-background hover:bg-foreground/85"
                  >
                    Learn more
                  </Button>
                </div>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselControls className="justify-center">
            <CarouselDots />
            <CarouselPlayButton />
            {!true && <CarouselNext size="icon-sm" />}
          </CarouselControls>
        </Carousel>
      </div>
    </div>
  )
}
```

### Shelf autoplay

The shelf advancing every three seconds and looping.

**Example**

```tsx
import { CaretRightIcon } from "@phosphor-icons/react"
import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselPlayButton,
} from "@/components/ui/carousel"

const popular = [
  {
    name: "Breakfast platter",
    price: "₺620",
    tint: "from-orange-500 to-red-500",
  },
  {
    name: "Grilled meatballs",
    price: "₺280",
    tint: "from-red-500 to-pink-500",
  },
  { name: "Menemen", price: "₺160", tint: "from-yellow-500 to-orange-500" },
  { name: "Lentil soup", price: "₺90", tint: "from-green-500 to-teal-500" },
  { name: "Künefe", price: "₺160", tint: "from-purple-500 to-indigo-500" },
]

export default function CarouselShelfAutoplay() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-md">
        <Carousel
          orientation="horizontal"
          autoplay={3000}
          opts={{ align: "start", loop: true }}
        >
          <div className="mb-3 flex items-center justify-between">
            <a
              href="#popular"
              className="flex items-center gap-1 text-xl font-bold tracking-tight"
            >
              Popular
              <CaretRightIcon className="size-4" />
            </a>
            <div className="flex items-center gap-3">
              <CarouselPlayButton variant="ghost" />
              <a href="#popular-all" className="text-primary">
                See all
              </a>
            </div>
          </div>
          <CarouselContent className="-ms-3">
            {popular.map((item) => (
              <CarouselItem key={item.name} className="basis-2/5 ps-3">
                <div
                  className={`aspect-square rounded-2xl bg-linear-to-br ${item.tint}`}
                />
                <p className="mt-2 truncate text-sm font-semibold">
                  {item.name}
                </p>
                <p className="text-xs text-muted-foreground tabular-nums">
                  {item.price}
                </p>
              </CarouselItem>
            ))}
          </CarouselContent>
        </Carousel>
      </div>
    </div>
  )
}
```

### Testimonials autoplay

Testimonials advancing every six seconds.

**Example**

```tsx
import {
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
  CarouselPrevious,
} from "@/components/ui/carousel"

const quotes = [
  { quote: "The checkout line is half as long.", author: "Ayşe Y. · Kadıköy" },
  {
    quote: "The kitchen finally keeps up on Fridays.",
    author: "Mert K. · Beşiktaş",
  },
  { quote: "Splitting the bill takes seconds now.", author: "Deniz A. · Moda" },
]

export default function CarouselTestimonialsAutoplay() {
  return (
    <div className="w-[min(56rem,calc(100vw-2rem))]">
      <div className="max-w-md rounded-3xl bg-muted p-8">
        <Carousel
          orientation="horizontal"
          autoplay={6000}
          opts={{ loop: true }}
        >
          <CarouselContent>
            {quotes.map((item) => (
              <CarouselItem key={item.quote}>
                <blockquote className="flex min-h-28 flex-col gap-3">
                  <p className="text-2xl font-bold tracking-tight">
                    “{item.quote}”
                  </p>
                  <footer className="text-muted-foreground">
                    {item.author}
                  </footer>
                </blockquote>
              </CarouselItem>
            ))}
          </CarouselContent>
          <CarouselControls className="justify-between">
            <div className="flex items-center gap-2">
              <CarouselPlayButton variant="ghost" />
              <CarouselDots variant="plain" />
            </div>
            <div className="flex gap-3">
              <CarouselPrevious size="icon-lg" />
              <CarouselNext size="icon-lg" />
            </div>
          </CarouselControls>
        </Carousel>
      </div>
    </div>
  )
}
```

## API Reference

- `Carousel`
- `CarouselContent`
  - `CarouselItem`
- `CarouselPrevious`
- `CarouselNext`
- `CarouselControls`
  - `CarouselDots`
  - `CarouselPlayButton`
  - `CarouselNext`
  - `CarouselPrevious`
- `CarouselPlayButton`

### Carousel

The root region that owns the Embla instance, keyboard handling and autoplay state.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `opts` | `CarouselOptions` | - | Options passed to Embla Carousel. |
| `plugins` | `CarouselPlugin` | - | Embla Carousel plugins. |
| `orientation` | `"horizontal" \| "vertical"` | `"horizontal"` | The scroll direction. |
| `setApi` | `(api: CarouselApi) => void` | - | Receives the Embla Carousel API once it is ready. |
| `autoplay` | `boolean \| number` | `false` | Advances the slides automatically; a number sets the delay in milliseconds. |

Also accepts the props of `React.ComponentProps<"div">`, `CarouselProps`.

### CarouselContent

The clipping viewport and the flex track that holds the slides.

Also accepts the props of `React.ComponentProps<"div">`.

### CarouselItem

A single slide.

Also accepts the props of `React.ComponentProps<"div">`.

### CarouselPrevious

A button that scrolls to the previous slide, disabled at the start.

Also accepts the props of `React.ComponentProps<typeof Button>`.

### CarouselNext

A button that scrolls to the next slide, disabled at the end.

Also accepts the props of `React.ComponentProps<typeof Button>`.

### CarouselControls

A row that lays out buttons, dots and the play button below the track.

Also accepts the props of `React.ComponentProps<"div">`.

### CarouselDots

One button per snap point that jumps to that slide and marks the current one.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `variant` | `"default" \| "plain"` | `"default"` | `default` places the dots on a blurred pill background; `plain` removes the background and padding. |

Also accepts the props of `React.ComponentProps<"div">`.

### CarouselPlayButton

Toggles autoplay between playing and paused.

Also accepts the props of `React.ComponentProps<typeof Button>`.

## Accessibility

- The root renders with `role="region"` and `aria-roledescription="carousel"`; each `CarouselItem` has `role="group"` and `aria-roledescription="slide"`. Add an `aria-label` to the root to name it.
- Arrow keys move between slides while focus is inside the carousel: left and right for horizontal (reversed in right-to-left layouts), up and down for vertical.
- `CarouselPrevious` and `CarouselNext` include visually hidden labels, `Previous slide` and `Next slide`. When one becomes disabled while focused, focus moves to the other.
- Each dot is labelled `Go to slide N`, and the current dot has `aria-current="true"`.
- `CarouselPlayButton` is labelled `Pause slideshow` or `Play slideshow` to match its state.

## Notes

- Styling hooks: `data-slot` values `carousel`, `carousel-content`, `carousel-item`, `carousel-previous`, `carousel-next`, `carousel-controls`, `carousel-dots` and `carousel-play-button`.
- The root sets `data-playing` while autoplay is running. Dots expose `data-active` on the current dot, and the dots container sets `data-variant` and `data-autoplay`.
- `CarouselPrevious` and `CarouselNext` default to the `secondary` variant and `icon` size; `CarouselPlayButton` defaults to `secondary` and `icon-sm`.
- In vertical carousels, standalone previous and next buttons are rotated 90 degrees; inside `CarouselControls` they are not.

**React Native, SwiftUI, Jetpack Compose**

![Preview](https://ui.suiss.app/previews/components-carousel--default.light.webp)

```tsx
import { View } from "react-native"
import { Card, CardContent } from "@/components/ui/card"
import { Carousel, CarouselContent, CarouselItem, CarouselNext, CarouselPrevious } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const slides = [1, 2, 3, 4, 5]

function NumberSlides({ basis }: { basis?: number }) {
  return (
    <CarouselContent>
      {slides.map((slide) => (
        <CarouselItem key={slide} basis={basis}>
          <Card size={basis ? "sm" : "default"}>
            <CardContent className="aspect-square items-center justify-center">
              <Text className="text-4xl font-semibold">{slide}</Text>
            </CardContent>
          </Card>
        </CarouselItem>
      ))}
    </CarouselContent>
  )
}

export function CarouselExample() {
  return (
    <View className="mx-12">
      <Carousel>
        <NumberSlides />
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselExample: View {
  var body: some View {
    Carousel {
      HStack(spacing: 12) {
        CarouselPrevious()
        CarouselNumberSlides(basis: nil)
        CarouselNext()
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselNumberSlides: View {
  let basis: CGFloat?

  var body: some View {
    CarouselContent {
      ForEach(CarouselData.slides, id: \.self) { slide in
        CarouselItem(basis: basis ?? 1) {
          Card(size: basis == nil ? .default : .sm) {
            CardContent {
              Text(verbatim: "\(slide)")
                .textStyle(.xl3, weight: .semibold)
                .frame(maxWidth: .infinity, maxHeight: .infinity)
                .aspectRatio(1, contentMode: .fit)
            }
          }
        }
      }
    }
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Card
import com.esuiss.ui.components.CardContent
import com.esuiss.ui.components.CardSize
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselNext
import com.esuiss.ui.components.CarouselPrevious
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Typography

@Composable
fun CarouselExample() {
    CarouselNumbers(basis = null, loop = false)
}

val carouselSlides = listOf(1, 2, 3, 4, 5)

val carouselSpacing = 16.dp

fun carouselPeek(width: Dp, basis: Float?, spacing: Dp = carouselSpacing): PaddingValues {
    if (basis == null) return PaddingValues(0.dp)
    val page = (width + spacing) * basis - spacing
    return PaddingValues(end = width - page)
}

@Composable
fun CarouselNumbers(basis: Float?, loop: Boolean) {
    val state = rememberCarouselState(pageCount = carouselSlides.size, loop = loop)
    BoxWithConstraints(Modifier.fillMaxWidth()) {
        val width = maxWidth
        Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
            CarouselContent(contentPadding = carouselPeek(width, basis)) { page ->
                CarouselItem {
                    Card(size = if (basis != null) CardSize.Sm else CardSize.Default) {
                        CardContent {
                            Box(Modifier.fillMaxWidth().aspectRatio(1f), contentAlignment = Alignment.Center) {
                                Text(
                                    carouselSlides[page].toString(),
                                    style = Typography.xl3.copy(fontWeight = FontWeight.SemiBold),
                                )
                            }
                        }
                    }
                }
            }
            Row(
                Modifier.fillMaxWidth().padding(top = 12.dp),
                horizontalArrangement = Arrangement.SpaceBetween,
                verticalAlignment = Alignment.CenterVertically,
            ) {
                CarouselPrevious()
                CarouselNext()
            }
        }
    }
}
```

`Carousel` wraps a scroll view that snaps to each `CarouselItem`. It scrolls horizontally by default or vertically with `orientation="vertical"`. `CarouselPrevious` and `CarouselNext` are round `Button`s that sit outside the slides, or inline when placed in `CarouselControls`.

`CarouselDots` shows one dot per snap point, with the active dot stretched into a pill; with autoplay on, the active dot fills up as a timer. `CarouselPlayButton` pauses and resumes autoplay.

## Installation

**React Native**

```bash title="Terminal"
npx shadcn@latest add @esuiss-rn/carousel
```

See [Installation](https://ui.suiss.app/docs/installation) for the `components.json` setup. Or use the suiss/ui CLI:

```bash title="Terminal"
npx @esuiss/ui@latest add carousel
```

**SwiftUI**

```bash title="Terminal"
npx @esuiss/ui@latest add carousel --platform swift
```

**Jetpack Compose**

```bash title="Terminal"
npx @esuiss/ui@latest add carousel --platform kotlin
```

The CLI also adds what it builds on: [Button](https://ui.suiss.app/docs/components/button), [Icon](https://ui.suiss.app/docs/components/icon). On React Native it also adds the animated view `components/ui/animated-view.tsx`.

### Manual

**React Native**

**Uniwind**

1. Install the dependencies:

```bash title="Terminal"
npx expo install cn phosphor-react-native react-native-reanimated react-native-svg react-native-worklets
```

2. Add the pieces it builds on: [Button](https://ui.suiss.app/docs/components/button), [Icon](https://ui.suiss.app/docs/components/icon), and the primitives `components/primitives/carousel.tsx`, `components/primitives/use-render.tsx`, and the animated view `components/ui/animated-view.tsx` from the next step.

3. Copy the animated view into `components/ui/animated-view.tsx`:

- `uniwind/components/ui/animated-view.tsx`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/uniwind/components/ui/animated-view.tsx)

4. Copy the source into `components/ui/carousel.tsx`:

```tsx title="uniwind/components/ui/carousel.tsx"
import { cn } from "cn"
import {
  CaretLeftIcon,
  CaretRightIcon,
  PauseIcon,
  PlayIcon,
} from "phosphor-react-native"
import * as React from "react"
import { I18nManager, View, type ViewProps } from "react-native"
import {
  cancelAnimation,
  Easing,
  ReduceMotion,
  useAnimatedStyle,
  useSharedValue,
  withTiming,
} from "react-native-reanimated"
import * as CarouselPrimitive from "@/components/primitives/carousel"
import { resolveClassName } from "@/components/primitives/use-render"
import { AnimatedView } from "@/components/ui/animated-view"
import { Button } from "@/components/ui/button"
import { Icon } from "@/components/ui/icon"

type CarouselApi = CarouselPrimitive.CarouselApi

const CarouselControlsContext = React.createContext(false)

const EASING = Easing.bezier(0.32, 0.72, 0, 1)

const DOT_SIZE = 8

const ACTIVE_DOT_WIDTH = 24

function useCarousel() {
  const context = CarouselPrimitive.useRootContext("useCarousel")
  return {
    api: context.api,
    orientation: context.orientation,
    opts: context.options,
    scrollPrev: context.scrollPrev,
    scrollNext: context.scrollNext,
    scrollTo: context.scrollTo,
    canScrollPrev: context.canScrollPrev,
    canScrollNext: context.canScrollNext,
    selectedIndex: context.selectedIndex,
    scrollSnaps: context.snaps,
    autoplay: context.autoplay,
  }
}

function Carousel({
  className,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Root>) {
  return (
    <CarouselPrimitive.Root
      className={(state) => cn("relative", resolveClassName(className, state))}
      {...props}
    />
  )
}

function CarouselContent({
  className,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Content>) {
  const { orientation } = useCarousel()
  return (
    <CarouselPrimitive.Viewport>
      <CarouselPrimitive.Content
        className={cn(
          orientation === "horizontal" ? "-ms-4" : "-mt-4",
          className
        )}
        {...props}
      />
    </CarouselPrimitive.Viewport>
  )
}

function CarouselItem({
  className,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Item>) {
  const { orientation } = useCarousel()
  return (
    <CarouselPrimitive.Item
      className={(state) =>
        cn(
          orientation === "horizontal" ? "ps-4" : "pt-4",
          resolveClassName(className, state)
        )
      }
      {...props}
    />
  )
}

function CarouselNavButton({
  direction,
  className,
  variant = "secondary",
  size = "icon",
  ...props
}: React.ComponentProps<typeof Button> & {
  direction: "previous" | "next"
}) {
  const { orientation } = useCarousel()
  const inControls = React.useContext(CarouselControlsContext)
  const horizontal = orientation === "horizontal"
  const Part =
    direction === "previous"
      ? CarouselPrimitive.Previous
      : CarouselPrimitive.Next
  const button = (
    <Part
      render={
        <Button
          variant={variant}
          size={size}
          className={cn(
            "rounded-full",
            !inControls && !horizontal && "rotate-90",
            className
          )}
          {...props}
        />
      }
    >
      <Icon
        as={direction === "previous" ? CaretLeftIcon : CaretRightIcon}
        mirrored={I18nManager.isRTL}
      />
    </Part>
  )
  if (inControls) return button
  return (
    <View
      className={cn(
        "absolute",
        horizontal
          ? "top-0 bottom-0 justify-center"
          : "right-0 left-0 items-center",
        horizontal && direction === "previous" && "-start-12",
        horizontal && direction === "next" && "-end-12",
        !horizontal && direction === "previous" && "-top-12",
        !horizontal && direction === "next" && "-bottom-12"
      )}
      style={{ pointerEvents: "box-none" }}
    >
      {button}
    </View>
  )
}

function CarouselPrevious(props: React.ComponentProps<typeof Button>) {
  return <CarouselNavButton direction="previous" {...props} />
}

function CarouselNext(props: React.ComponentProps<typeof Button>) {
  return <CarouselNavButton direction="next" {...props} />
}

function CarouselControls({ className, ...props }: ViewProps) {
  return (
    <CarouselControlsContext.Provider value>
      <View
        className={cn("mt-6 flex-row items-center gap-3", className)}
        {...props}
      />
    </CarouselControlsContext.Provider>
  )
}

function CarouselDotProgress({
  delay,
  playing,
  running,
}: {
  delay: number
  playing: boolean
  running: boolean
}) {
  const progress = useSharedValue(playing ? 0 : 1)

  React.useEffect(() => {
    if (playing) return
    cancelAnimation(progress)
    progress.value = 1
  }, [playing, progress])

  React.useEffect(() => {
    if (!playing) return
    if (!running) {
      cancelAnimation(progress)
      return
    }
    if (progress.value >= 1) progress.value = 0
    progress.value = withTiming(1, {
      duration: delay * (1 - progress.value),
      easing: Easing.linear,
      reduceMotion: ReduceMotion.System,
    })
  }, [playing, running, delay, progress])

  const animatedStyle = useAnimatedStyle(() => ({
    width: progress.value * ACTIVE_DOT_WIDTH,
  }))

  return (
    <AnimatedView
      className="absolute top-0 bottom-0 start-0 rounded-full bg-foreground"
      style={animatedStyle}
    />
  )
}

function CarouselDot({ index }: { index: number }) {
  const { selectedIndex, autoplay } = useCarousel()
  const active = index === selectedIndex
  const width = useSharedValue(active ? ACTIVE_DOT_WIDTH : DOT_SIZE)

  React.useEffect(() => {
    width.value = withTiming(active ? ACTIVE_DOT_WIDTH : DOT_SIZE, {
      duration: 500,
      easing: EASING,
      reduceMotion: ReduceMotion.System,
    })
  }, [active, width])

  const animatedStyle = useAnimatedStyle(() => ({ width: width.value }))

  return (
    <CarouselPrimitive.Dot index={index} hitSlop={8} className="h-2">
      <AnimatedView
        className={cn(
          "h-2 overflow-hidden rounded-full",
          active && !autoplay.enabled ? "bg-foreground" : "bg-muted-foreground"
        )}
        style={animatedStyle}
      >
        {active && autoplay.enabled ? (
          <CarouselDotProgress
            delay={autoplay.delay}
            playing={autoplay.playing}
            running={autoplay.running}
          />
        ) : null}
      </AnimatedView>
    </CarouselPrimitive.Dot>
  )
}

function CarouselDots({
  className,
  variant = "default",
  ...props
}: ViewProps & { variant?: "default" | "plain" }) {
  const { scrollSnaps } = useCarousel()
  return (
    <View
      className={cn(
        "h-9 flex-row items-center gap-4 rounded-full",
        variant === "plain" ? "px-0" : "bg-secondary px-4",
        className
      )}
      {...props}
    >
      {scrollSnaps
        .map((_, index) => index)
        .map((index) => (
          <CarouselDot key={index} index={index} />
        ))}
    </View>
  )
}

function CarouselPlayButton({
  className,
  variant = "secondary",
  size = "icon-sm",
  ...props
}: React.ComponentProps<typeof Button>) {
  const { autoplay } = useCarousel()
  return (
    <CarouselPrimitive.PlayButton
      render={
        <Button
          variant={variant}
          size={size}
          className={cn("rounded-full", className)}
          {...props}
        />
      }
    >
      <Icon as={autoplay.playing ? PauseIcon : PlayIcon} weight="fill" />
    </CarouselPrimitive.PlayButton>
  )
}

export {
  Carousel,
  type CarouselApi,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
  CarouselPrevious,
  useCarousel,
}
```

5. Update the import paths to match your project.

**NativeWind**

1. Install the dependencies:

```bash title="Terminal"
npx expo install cn phosphor-react-native react-native-reanimated react-native-svg react-native-worklets
```

2. Add the pieces it builds on: [Button](https://ui.suiss.app/docs/components/button), [Icon](https://ui.suiss.app/docs/components/icon), and the primitives `components/primitives/carousel.tsx`, `components/primitives/use-render.tsx`, and the animated view `components/ui/animated-view.tsx` from the next step.

3. Copy the animated view into `components/ui/animated-view.tsx`:

- `nativewind/components/ui/animated-view.tsx`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/nativewind/components/ui/animated-view.tsx)

4. Copy the source into `components/ui/carousel.tsx`:

```tsx title="nativewind/components/ui/carousel.tsx"
import { cn } from "cn"
import {
  CaretLeftIcon,
  CaretRightIcon,
  PauseIcon,
  PlayIcon,
} from "phosphor-react-native"
import * as React from "react"
import { I18nManager, View, type ViewProps } from "react-native"
import {
  cancelAnimation,
  Easing,
  ReduceMotion,
  useAnimatedStyle,
  useSharedValue,
  withTiming,
} from "react-native-reanimated"
import * as CarouselPrimitive from "@/components/primitives/carousel"
import { resolveClassName } from "@/components/primitives/use-render"
import { AnimatedView } from "@/components/ui/animated-view"
import { Button } from "@/components/ui/button"
import { Icon } from "@/components/ui/icon"

type CarouselApi = CarouselPrimitive.CarouselApi

const CarouselControlsContext = React.createContext(false)

const EASING = Easing.bezier(0.32, 0.72, 0, 1)

const DOT_SIZE = 8

const ACTIVE_DOT_WIDTH = 24

function useCarousel() {
  const context = CarouselPrimitive.useRootContext("useCarousel")
  return {
    api: context.api,
    orientation: context.orientation,
    opts: context.options,
    scrollPrev: context.scrollPrev,
    scrollNext: context.scrollNext,
    scrollTo: context.scrollTo,
    canScrollPrev: context.canScrollPrev,
    canScrollNext: context.canScrollNext,
    selectedIndex: context.selectedIndex,
    scrollSnaps: context.snaps,
    autoplay: context.autoplay,
  }
}

function Carousel({
  className,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Root>) {
  return (
    <CarouselPrimitive.Root
      className={(state) => cn("relative", resolveClassName(className, state))}
      {...props}
    />
  )
}

function CarouselContent({
  className,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Content>) {
  const { orientation } = useCarousel()
  return (
    <CarouselPrimitive.Viewport>
      <CarouselPrimitive.Content
        className={cn(
          orientation === "horizontal" ? "-ms-4" : "-mt-4",
          className
        )}
        {...props}
      />
    </CarouselPrimitive.Viewport>
  )
}

function CarouselItem({
  className,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Item>) {
  const { orientation } = useCarousel()
  return (
    <CarouselPrimitive.Item
      className={(state) =>
        cn(
          orientation === "horizontal" ? "ps-4" : "pt-4",
          resolveClassName(className, state)
        )
      }
      {...props}
    />
  )
}

function CarouselNavButton({
  direction,
  className,
  variant = "secondary",
  size = "icon",
  ...props
}: React.ComponentProps<typeof Button> & {
  direction: "previous" | "next"
}) {
  const { orientation } = useCarousel()
  const inControls = React.useContext(CarouselControlsContext)
  const horizontal = orientation === "horizontal"
  const Part =
    direction === "previous"
      ? CarouselPrimitive.Previous
      : CarouselPrimitive.Next
  const button = (
    <Part
      render={
        <Button
          variant={variant}
          size={size}
          className={cn(
            "rounded-full",
            !inControls && !horizontal && "rotate-90",
            className
          )}
          {...props}
        />
      }
    >
      <Icon
        as={direction === "previous" ? CaretLeftIcon : CaretRightIcon}
        mirrored={I18nManager.isRTL}
      />
    </Part>
  )
  if (inControls) return button
  return (
    <View
      className={cn(
        "absolute",
        horizontal
          ? "top-0 bottom-0 justify-center"
          : "right-0 left-0 items-center",
        horizontal && direction === "previous" && "-start-12",
        horizontal && direction === "next" && "-end-12",
        !horizontal && direction === "previous" && "-top-12",
        !horizontal && direction === "next" && "-bottom-12"
      )}
      style={{ pointerEvents: "box-none" }}
    >
      {button}
    </View>
  )
}

function CarouselPrevious(props: React.ComponentProps<typeof Button>) {
  return <CarouselNavButton direction="previous" {...props} />
}

function CarouselNext(props: React.ComponentProps<typeof Button>) {
  return <CarouselNavButton direction="next" {...props} />
}

function CarouselControls({ className, ...props }: ViewProps) {
  return (
    <CarouselControlsContext.Provider value>
      <View
        className={cn("mt-6 flex-row items-center gap-3", className)}
        {...props}
      />
    </CarouselControlsContext.Provider>
  )
}

function CarouselDotProgress({
  delay,
  playing,
  running,
}: {
  delay: number
  playing: boolean
  running: boolean
}) {
  const progress = useSharedValue(playing ? 0 : 1)

  React.useEffect(() => {
    if (playing) return
    cancelAnimation(progress)
    progress.value = 1
  }, [playing, progress])

  React.useEffect(() => {
    if (!playing) return
    if (!running) {
      cancelAnimation(progress)
      return
    }
    if (progress.value >= 1) progress.value = 0
    progress.value = withTiming(1, {
      duration: delay * (1 - progress.value),
      easing: Easing.linear,
      reduceMotion: ReduceMotion.System,
    })
  }, [playing, running, delay, progress])

  const animatedStyle = useAnimatedStyle(() => ({
    width: progress.value * ACTIVE_DOT_WIDTH,
  }))

  return (
    <AnimatedView
      className="absolute top-0 bottom-0 start-0 rounded-full bg-foreground"
      style={animatedStyle}
    />
  )
}

function CarouselDot({ index }: { index: number }) {
  const { selectedIndex, autoplay } = useCarousel()
  const active = index === selectedIndex
  const width = useSharedValue(active ? ACTIVE_DOT_WIDTH : DOT_SIZE)

  React.useEffect(() => {
    width.value = withTiming(active ? ACTIVE_DOT_WIDTH : DOT_SIZE, {
      duration: 500,
      easing: EASING,
      reduceMotion: ReduceMotion.System,
    })
  }, [active, width])

  const animatedStyle = useAnimatedStyle(() => ({ width: width.value }))

  return (
    <CarouselPrimitive.Dot index={index} hitSlop={8} className="h-2">
      <AnimatedView
        className={cn(
          "h-2 overflow-hidden rounded-full",
          active && !autoplay.enabled ? "bg-foreground" : "bg-muted-foreground"
        )}
        style={animatedStyle}
      >
        {active && autoplay.enabled ? (
          <CarouselDotProgress
            delay={autoplay.delay}
            playing={autoplay.playing}
            running={autoplay.running}
          />
        ) : null}
      </AnimatedView>
    </CarouselPrimitive.Dot>
  )
}

function CarouselDots({
  className,
  variant = "default",
  ...props
}: ViewProps & { variant?: "default" | "plain" }) {
  const { scrollSnaps } = useCarousel()
  return (
    <View
      className={cn(
        "h-9 flex-row items-center gap-4 rounded-full",
        variant === "plain" ? "px-0" : "bg-secondary px-4",
        className
      )}
      {...props}
    >
      {scrollSnaps
        .map((_, index) => index)
        .map((index) => (
          <CarouselDot key={index} index={index} />
        ))}
    </View>
  )
}

function CarouselPlayButton({
  className,
  variant = "secondary",
  size = "icon-sm",
  ...props
}: React.ComponentProps<typeof Button>) {
  const { autoplay } = useCarousel()
  return (
    <CarouselPrimitive.PlayButton
      render={
        <Button
          variant={variant}
          size={size}
          className={cn("rounded-full", className)}
          {...props}
        />
      }
    >
      <Icon as={autoplay.playing ? PauseIcon : PlayIcon} weight="fill" />
    </CarouselPrimitive.PlayButton>
  )
}

export {
  Carousel,
  type CarouselApi,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
  CarouselPrevious,
  useCarousel,
}
```

5. Update the import paths to match your project.

**StyleSheet**

1. Install the dependencies:

```bash title="Terminal"
npx expo install phosphor-react-native react-native-reanimated react-native-svg react-native-worklets
```

2. Add the pieces it builds on: [Button](https://ui.suiss.app/docs/components/button), [Icon](https://ui.suiss.app/docs/components/icon), and the primitives `components/primitives/carousel.tsx`, `components/primitives/use-render.tsx`, and the animated view `components/ui/animated-view.tsx` from the next step.

3. Copy the animated view into `components/ui/animated-view.tsx`:

- `stylesheet/components/ui/animated-view.tsx`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/stylesheet/components/ui/animated-view.tsx)

4. Copy the source into `components/ui/carousel.tsx`:

```tsx title="stylesheet/components/ui/carousel.tsx"
import {
  CaretLeftIcon,
  CaretRightIcon,
  PauseIcon,
  PlayIcon,
} from "phosphor-react-native"
import * as React from "react"
import { I18nManager, StyleSheet, View, type ViewProps } from "react-native"
import {
  cancelAnimation,
  Easing,
  ReduceMotion,
  useAnimatedStyle,
  useSharedValue,
  withTiming,
} from "react-native-reanimated"
import * as CarouselPrimitive from "@/components/primitives/carousel"
import { resolveStyle } from "@/components/primitives/use-render"
import { AnimatedView } from "@/components/ui/animated-view"
import { Button } from "@/components/ui/button"
import { Icon } from "@/components/ui/icon"
import { radius, useTheme } from "@/components/ui/theme"

type CarouselApi = CarouselPrimitive.CarouselApi

const CarouselControlsContext = React.createContext(false)

const EASING = Easing.bezier(0.32, 0.72, 0, 1)

const DOT_SIZE = 8

const ACTIVE_DOT_WIDTH = 24

const styles = StyleSheet.create({
  root: { position: "relative" },
  contentHorizontal: { marginStart: -16 },
  contentVertical: { marginTop: -16 },
  itemHorizontal: { paddingStart: 16 },
  itemVertical: { paddingTop: 16 },
  round: { borderRadius: radius.full },
  rotate: { transform: [{ rotate: "90deg" }] },
  navHorizontal: {
    position: "absolute",
    top: 0,
    bottom: 0,
    justifyContent: "center",
    pointerEvents: "box-none",
  },
  navVertical: {
    position: "absolute",
    left: 0,
    right: 0,
    alignItems: "center",
    pointerEvents: "box-none",
  },
  previousHorizontal: { start: -48 },
  nextHorizontal: { end: -48 },
  previousVertical: { top: -48 },
  nextVertical: { bottom: -48 },
  controls: {
    marginTop: 24,
    flexDirection: "row",
    alignItems: "center",
    gap: 12,
  },
  dots: {
    height: 36,
    flexDirection: "row",
    alignItems: "center",
    gap: 16,
    borderRadius: radius.full,
  },
  dotsDefault: { paddingHorizontal: 16 },
  dotHit: { height: DOT_SIZE },
  dot: { height: DOT_SIZE, overflow: "hidden", borderRadius: radius.full },
  progress: {
    position: "absolute",
    top: 0,
    bottom: 0,
    start: 0,
    borderRadius: radius.full,
  },
})

function useCarousel() {
  const context = CarouselPrimitive.useRootContext("useCarousel")
  return {
    api: context.api,
    orientation: context.orientation,
    opts: context.options,
    scrollPrev: context.scrollPrev,
    scrollNext: context.scrollNext,
    scrollTo: context.scrollTo,
    canScrollPrev: context.canScrollPrev,
    canScrollNext: context.canScrollNext,
    selectedIndex: context.selectedIndex,
    scrollSnaps: context.snaps,
    autoplay: context.autoplay,
  }
}

function Carousel({
  style,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Root>) {
  return (
    <CarouselPrimitive.Root
      style={(state) => [
        styles.root,
        resolveStyle(style, state) as ViewProps["style"],
      ]}
      {...props}
    />
  )
}

function CarouselContent({
  style,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Content>) {
  const { orientation } = useCarousel()
  return (
    <CarouselPrimitive.Viewport>
      <CarouselPrimitive.Content
        style={[
          orientation === "horizontal"
            ? styles.contentHorizontal
            : styles.contentVertical,
          style,
        ]}
        {...props}
      />
    </CarouselPrimitive.Viewport>
  )
}

function CarouselItem({
  style,
  ...props
}: React.ComponentProps<typeof CarouselPrimitive.Item>) {
  const { orientation } = useCarousel()
  return (
    <CarouselPrimitive.Item
      style={(state) => [
        orientation === "horizontal"
          ? styles.itemHorizontal
          : styles.itemVertical,
        resolveStyle(style, state) as ViewProps["style"],
      ]}
      {...props}
    />
  )
}

function CarouselNavButton({
  direction,
  style,
  variant = "secondary",
  size = "icon",
  ...props
}: React.ComponentProps<typeof Button> & {
  direction: "previous" | "next"
}) {
  const { orientation } = useCarousel()
  const inControls = React.useContext(CarouselControlsContext)
  const horizontal = orientation === "horizontal"
  const Part =
    direction === "previous"
      ? CarouselPrimitive.Previous
      : CarouselPrimitive.Next
  const button = (
    <Part
      render={
        <Button
          variant={variant}
          size={size}
          style={(state) => [
            styles.round,
            !inControls && !horizontal && styles.rotate,
            typeof style === "function" ? style(state) : style,
          ]}
          {...props}
        />
      }
    >
      <Icon
        as={direction === "previous" ? CaretLeftIcon : CaretRightIcon}
        mirrored={I18nManager.isRTL}
      />
    </Part>
  )
  if (inControls) return button
  return (
    <View
      style={[
        horizontal ? styles.navHorizontal : styles.navVertical,
        horizontal &&
          (direction === "previous"
            ? styles.previousHorizontal
            : styles.nextHorizontal),
        !horizontal &&
          (direction === "previous"
            ? styles.previousVertical
            : styles.nextVertical),
      ]}
    >
      {button}
    </View>
  )
}

function CarouselPrevious(props: React.ComponentProps<typeof Button>) {
  return <CarouselNavButton direction="previous" {...props} />
}

function CarouselNext(props: React.ComponentProps<typeof Button>) {
  return <CarouselNavButton direction="next" {...props} />
}

function CarouselControls({ style, ...props }: ViewProps) {
  return (
    <CarouselControlsContext.Provider value>
      <View style={[styles.controls, style]} {...props} />
    </CarouselControlsContext.Provider>
  )
}

function CarouselDotProgress({
  delay,
  playing,
  running,
}: {
  delay: number
  playing: boolean
  running: boolean
}) {
  const { colors } = useTheme()
  const progress = useSharedValue(playing ? 0 : 1)

  React.useEffect(() => {
    if (playing) return
    cancelAnimation(progress)
    progress.value = 1
  }, [playing, progress])

  React.useEffect(() => {
    if (!playing) return
    if (!running) {
      cancelAnimation(progress)
      return
    }
    if (progress.value >= 1) progress.value = 0
    progress.value = withTiming(1, {
      duration: delay * (1 - progress.value),
      easing: Easing.linear,
      reduceMotion: ReduceMotion.System,
    })
  }, [playing, running, delay, progress])

  const animatedStyle = useAnimatedStyle(() => ({
    width: progress.value * ACTIVE_DOT_WIDTH,
  }))

  return (
    <AnimatedView
      style={[
        styles.progress,
        { backgroundColor: colors.foreground },
        animatedStyle,
      ]}
    />
  )
}

function CarouselDot({ index }: { index: number }) {
  const { colors } = useTheme()
  const { selectedIndex, autoplay } = useCarousel()
  const active = index === selectedIndex
  const width = useSharedValue(active ? ACTIVE_DOT_WIDTH : DOT_SIZE)

  React.useEffect(() => {
    width.value = withTiming(active ? ACTIVE_DOT_WIDTH : DOT_SIZE, {
      duration: 500,
      easing: EASING,
      reduceMotion: ReduceMotion.System,
    })
  }, [active, width])

  const animatedStyle = useAnimatedStyle(() => ({ width: width.value }))

  return (
    <CarouselPrimitive.Dot index={index} hitSlop={8} style={styles.dotHit}>
      <AnimatedView
        style={[
          styles.dot,
          {
            backgroundColor:
              active && !autoplay.enabled
                ? colors.foreground
                : colors.mutedForeground,
          },
          animatedStyle,
        ]}
      >
        {active && autoplay.enabled ? (
          <CarouselDotProgress
            delay={autoplay.delay}
            playing={autoplay.playing}
            running={autoplay.running}
          />
        ) : null}
      </AnimatedView>
    </CarouselPrimitive.Dot>
  )
}

function CarouselDots({
  style,
  variant = "default",
  ...props
}: ViewProps & { variant?: "default" | "plain" }) {
  const { colors } = useTheme()
  const { scrollSnaps } = useCarousel()
  return (
    <View
      style={[
        styles.dots,
        variant === "plain"
          ? undefined
          : [styles.dotsDefault, { backgroundColor: colors.secondary }],
        style,
      ]}
      {...props}
    >
      {scrollSnaps
        .map((_, index) => index)
        .map((index) => (
          <CarouselDot key={index} index={index} />
        ))}
    </View>
  )
}

function CarouselPlayButton({
  style,
  variant = "secondary",
  size = "icon-sm",
  ...props
}: React.ComponentProps<typeof Button>) {
  const { autoplay } = useCarousel()
  return (
    <CarouselPrimitive.PlayButton
      render={
        <Button
          variant={variant}
          size={size}
          style={(state) => [
            styles.round,
            typeof style === "function" ? style(state) : style,
          ]}
          {...props}
        />
      }
    >
      <Icon as={autoplay.playing ? PauseIcon : PlayIcon} weight="fill" />
    </CarouselPrimitive.PlayButton>
  )
}

export {
  Carousel,
  type CarouselApi,
  CarouselContent,
  CarouselControls,
  CarouselDots,
  CarouselItem,
  CarouselNext,
  CarouselPlayButton,
  CarouselPrevious,
  useCarousel,
}
```

5. Update the import paths to match your project.

**SwiftUI**

1. Target iOS 17 or later.

2. Add the Swift package to your app:

```swift title="Package.swift"
.package(url: "https://github.com/phosphor-icons/swift", from: "2.1.0")
```

3. Copy the theme files every view uses:

- `swift/Theme/Theme.swift`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/swiftui/Sources/EsuissUI/Theme/Theme.swift)

- `swift/Theme/Tokens.swift`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/swiftui/Sources/EsuissUI/Theme/Tokens.swift)

4. Copy the source and every file it uses:

```swift title="swift/Components/Carousel.swift"
import PhosphorSwift
import SwiftUI

public enum CarouselOrientation: CaseIterable, Sendable {
  case horizontal, vertical
}

public enum CarouselDotsVariant: CaseIterable, Sendable {
  case `default`, plain
}

let carouselAnimation = Animation.timingCurve(0.32, 0.72, 0, 1, duration: 0.5)

enum CarouselMath {
  static func clamp(_ index: Int, count: Int) -> Int {
    count == 0 ? 0 : min(max(index, 0), count - 1)
  }

  static func step(from index: Int, by delta: Int, count: Int, loop: Bool) -> Int? {
    guard count > 0 else { return nil }
    let next = index + delta
    if next >= 0 && next < count { return next }
    guard loop, count > 1 else { return nil }
    return ((next % count) + count) % count
  }

  static func autoplayTarget(from index: Int, count: Int, loop: Bool) -> Int? {
    guard count > 1 else { return nil }
    return step(from: index, by: 1, count: count, loop: loop) ?? 0
  }
}

@MainActor
@Observable
public final class CarouselController {
  public private(set) var selectedIndex = 0
  public private(set) var count = 0
  public internal(set) var isPlaying = false

  var keys: [UUID] = []
  var loop = false
  var reduceMotion = false
  var autoplayEnabled = false
  var autoplayDelay: Duration = .seconds(5)
  var autoplayStart: Date?

  public init() {}

  public var canScrollPrev: Bool {
    CarouselMath.step(from: selectedIndex, by: -1, count: count, loop: loop) != nil
  }

  public var canScrollNext: Bool {
    CarouselMath.step(from: selectedIndex, by: 1, count: count, loop: loop) != nil
  }

  public func scrollTo(_ index: Int, animated: Bool = true) {
    let target = CarouselMath.clamp(index, count: count)
    guard target != selectedIndex else { return }
    if animated && !reduceMotion {
      withAnimation(carouselAnimation) { selectedIndex = target }
    } else {
      selectedIndex = target
    }
  }

  public func scrollPrev() {
    if let target = CarouselMath.step(from: selectedIndex, by: -1, count: count, loop: loop) {
      scrollTo(target)
    }
  }

  public func scrollNext() {
    if let target = CarouselMath.step(from: selectedIndex, by: 1, count: count, loop: loop) {
      scrollTo(target)
    }
  }

  public func setPlaying(_ playing: Bool) {
    isPlaying = autoplayEnabled && playing
  }

  func register(_ keys: [UUID]) {
    self.keys = keys
    count = keys.count
    selectedIndex = CarouselMath.clamp(selectedIndex, count: count)
  }

  var position: UUID? {
    get { keys.indices.contains(selectedIndex) ? keys[selectedIndex] : nil }
    set {
      if let newValue, let index = keys.firstIndex(of: newValue) {
        selectedIndex = index
      }
    }
  }
}

extension EnvironmentValues {
  @Entry var carousel: CarouselController? = nil
  @Entry var carouselOrientation: CarouselOrientation = .horizontal
  @Entry var carouselSpacing: CGFloat = 16
}

struct CarouselKeysKey: PreferenceKey {
  static var defaultValue: [UUID] { [] }

  static func reduce(value: inout [UUID], nextValue: () -> [UUID]) {
    value.append(contentsOf: nextValue())
  }
}

private struct CarouselAutoplayKey: Hashable {
  let index: Int
  let count: Int
  let running: Bool
}

public struct Carousel<Content: View>: View {
  let orientation: CarouselOrientation
  let loop: Bool
  let autoplay: Duration?
  let external: CarouselController?
  let onSelect: ((Int) -> Void)?
  let content: Content

  @State private var local = CarouselController()
  @Environment(\.accessibilityReduceMotion) private var reduceMotion
  @Environment(\.scenePhase) private var scenePhase

  public init(
    orientation: CarouselOrientation = .horizontal,
    loop: Bool = false,
    autoplay: Duration? = nil,
    controller: CarouselController? = nil,
    onSelect: ((Int) -> Void)? = nil,
    @ViewBuilder content: () -> Content
  ) {
    self.orientation = orientation
    self.loop = loop
    self.autoplay = autoplay
    self.external = controller
    self.onSelect = onSelect
    self.content = content()
  }

  public var body: some View {
    let controller = external ?? local
    let running = controller.isPlaying && scenePhase != .background
    VStack(spacing: 0) {
      content
    }
    .environment(\.carousel, controller)
    .environment(\.carouselOrientation, orientation)
    .onAppear {
      controller.loop = loop
      controller.reduceMotion = reduceMotion
      controller.autoplayEnabled = autoplay != nil
      controller.autoplayDelay = autoplay ?? .seconds(5)
      controller.isPlaying = autoplay != nil && !reduceMotion
    }
    .onChange(of: loop) { _, value in controller.loop = value }
    .onChange(of: reduceMotion) { _, value in controller.reduceMotion = value }
    .onChange(of: controller.selectedIndex) { _, value in onSelect?(value) }
    .task(id: CarouselAutoplayKey(index: controller.selectedIndex, count: controller.count, running: running)) {
      guard running, let delay = autoplay else {
        controller.autoplayStart = nil
        return
      }
      controller.autoplayStart = .now
      do {
        try await Task.sleep(for: delay)
      } catch {
        return
      }
      if let target = CarouselMath.autoplayTarget(from: controller.selectedIndex, count: controller.count, loop: controller.loop) {
        controller.scrollTo(target)
      }
    }
    .accessibilityElement(children: .contain)
  }
}

public struct CarouselContent<Content: View>: View {
  let spacing: CGFloat
  let content: Content

  @State private var keys: [UUID] = []
  @Environment(\.carousel) private var carousel
  @Environment(\.carouselOrientation) private var orientation

  public init(spacing: CGFloat = 16, @ViewBuilder content: () -> Content) {
    self.spacing = spacing
    self.content = content()
  }

  public var body: some View {
    let horizontal = orientation == .horizontal
    ScrollView(horizontal ? .horizontal : .vertical) {
      Group {
        if horizontal {
          HStack(spacing: spacing) { content }
        } else {
          VStack(spacing: spacing) { content }
        }
      }
      .scrollTargetLayout()
    }
    .scrollIndicators(.hidden)
    .scrollTargetBehavior(.viewAligned(limitBehavior: .always))
    .scrollPosition(id: position)
    .environment(\.carouselSpacing, spacing)
    .onPreferenceChange(CarouselKeysKey.self) { value in keys = value }
    .onChange(of: keys, initial: true) { _, value in carousel?.register(value) }
  }

  private var position: Binding<UUID?> {
    let carousel = carousel
    return Binding(
      get: { carousel?.position },
      set: { carousel?.position = $0 }
    )
  }
}

public struct CarouselItem<Content: View>: View {
  let basis: CGFloat
  let content: Content

  @State private var key = UUID()
  @Environment(\.carousel) private var carousel
  @Environment(\.carouselOrientation) private var orientation
  @Environment(\.carouselSpacing) private var spacing

  public init(basis: CGFloat = 1, @ViewBuilder content: () -> Content) {
    self.basis = basis
    self.content = content()
  }

  public var body: some View {
    let index = carousel?.keys.firstIndex(of: key)
    content
      .containerRelativeFrame(orientation == .horizontal ? .horizontal : .vertical) { length, _ in
        max(0, (length + spacing) * min(max(basis, 0), 1) - spacing)
      }
      .id(key)
      .preference(key: CarouselKeysKey.self, value: [key])
      .accessibilityElement(children: .contain)
      .accessibilityLabel(index.map { Text("Slide \($0 + 1) of \(carousel?.count ?? 0)") } ?? Text(verbatim: ""))
  }
}

public struct CarouselPrevious: View {
  let variant: VariantButtonStyle.Variant
  let size: VariantButtonStyle.Size

  @Environment(\.carousel) private var carousel
  @Environment(\.carouselOrientation) private var orientation

  public init(variant: VariantButtonStyle.Variant = .secondary, size: VariantButtonStyle.Size = .icon) {
    self.variant = variant
    self.size = size
  }

  public var body: some View {
    Button {
      carousel?.scrollPrev()
    } label: {
      (orientation == .horizontal ? Ph.caretLeft.bold : Ph.caretUp.bold)
        .frame(width: 16, height: 16)
        .flipsForRightToLeftLayoutDirection(orientation == .horizontal)
    }
    .buttonStyle(.variant(variant, size: size))
    .disabled(!(carousel?.canScrollPrev ?? false))
    .accessibilityLabel(Text("Previous slide"))
  }
}

public struct CarouselNext: View {
  let variant: VariantButtonStyle.Variant
  let size: VariantButtonStyle.Size

  @Environment(\.carousel) private var carousel
  @Environment(\.carouselOrientation) private var orientation

  public init(variant: VariantButtonStyle.Variant = .secondary, size: VariantButtonStyle.Size = .icon) {
    self.variant = variant
    self.size = size
  }

  public var body: some View {
    Button {
      carousel?.scrollNext()
    } label: {
      (orientation == .horizontal ? Ph.caretRight.bold : Ph.caretDown.bold)
        .frame(width: 16, height: 16)
        .flipsForRightToLeftLayoutDirection(orientation == .horizontal)
    }
    .buttonStyle(.variant(variant, size: size))
    .disabled(!(carousel?.canScrollNext ?? false))
    .accessibilityLabel(Text("Next slide"))
  }
}

public struct CarouselControls<Content: View>: View {
  let content: Content

  public init(@ViewBuilder content: () -> Content) {
    self.content = content()
  }

  public var body: some View {
    HStack(spacing: 12) {
      content
    }
    .padding(.top, 24)
  }
}

public struct CarouselDots: View {
  let variant: CarouselDotsVariant

  @Environment(\.carousel) private var carousel
  @Environment(\.accessibilityReduceMotion) private var reduceMotion

  public init(variant: CarouselDotsVariant = .default) {
    self.variant = variant
  }

  public var body: some View {
    let count = carousel?.count ?? 0
    let selected = carousel?.selectedIndex ?? 0
    let autoplay = carousel?.autoplayEnabled ?? false
    HStack(spacing: 16) {
      ForEach(0..<count, id: \.self) { index in
        let active = index == selected
        Button {
          carousel?.scrollTo(index)
        } label: {
          Capsule()
            .fill(active ? (autoplay ? EsuissColor.mutedForeground : EsuissColor.foreground) : EsuissColor.mutedForeground)
            .frame(width: active ? 24 : 8, height: 8)
            .overlay(alignment: .leading) {
              if active && autoplay, let carousel {
                CarouselDotsFill(carousel: carousel)
              }
            }
            .clipShape(Capsule())
            .padding(8)
            .contentShape(Rectangle())
        }
        .buttonStyle(.plain)
        .padding(-8)
        .accessibilityLabel(Text("Go to slide \(index + 1)"))
        .accessibilityAddTraits(active ? .isSelected : [])
      }
    }
    .animation(reduceMotion ? nil : carouselAnimation, value: selected)
    .frame(height: 36)
    .padding(.horizontal, variant == .default ? 16 : 0)
    .background {
      if variant == .default {
        Capsule().fill(EsuissColor.secondary)
      }
    }
  }
}

private struct CarouselDotsFill: View {
  let carousel: CarouselController

  var body: some View {
    TimelineView(.animation(paused: carousel.autoplayStart == nil)) { timeline in
      GeometryReader { proxy in
        Capsule()
          .fill(EsuissColor.foreground)
          .frame(width: proxy.size.width * fraction(at: timeline.date))
      }
    }
  }

  private func fraction(at date: Date) -> CGFloat {
    guard carousel.isPlaying else { return 1 }
    guard let start = carousel.autoplayStart else { return 0 }
    let delay = carousel.autoplayDelay / .seconds(1)
    guard delay > 0 else { return 1 }
    return min(max(date.timeIntervalSince(start) / delay, 0), 1)
  }
}

public struct CarouselPlayButton: View {
  let variant: VariantButtonStyle.Variant
  let size: VariantButtonStyle.Size

  @Environment(\.carousel) private var carousel

  public init(variant: VariantButtonStyle.Variant = .secondary, size: VariantButtonStyle.Size = .iconSm) {
    self.variant = variant
    self.size = size
  }

  public var body: some View {
    if let carousel, carousel.autoplayEnabled {
      let playing = carousel.isPlaying
      Button {
        carousel.setPlaying(!playing)
      } label: {
        (playing ? Ph.pause.fill : Ph.play.fill)
          .frame(width: 14, height: 14)
      }
      .buttonStyle(.variant(variant, size: size))
      .accessibilityLabel(playing ? Text("Pause slideshow") : Text("Play slideshow"))
    }
  }
}
```

- `swift/Components/Button.swift`: see [Button](https://ui.suiss.app/docs/components/button.md)

- `swift/Components/ButtonGroup.swift`: see [Button Group](https://ui.suiss.app/docs/components/button-group.md)

- `swift/Components/TextVariant.swift`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/swiftui/Sources/EsuissUI/Components/TextVariant.swift)

5. Add the files to your app target.

**Jetpack Compose**

1. Set `minSdk` to 24 or higher and add the dependencies:

```kotlin title="build.gradle.kts"
implementation(platform("androidx.compose:compose-bom:2026.09.00"))
implementation("androidx.compose.foundation:foundation")
implementation("androidx.compose.ui:ui")
implementation("com.adamglin:phosphor-icon-android:1.0.0")
```

2. Copy the theme files every view uses:

- `kotlin/theme/Theme.kt`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/kotlin/ui/src/main/kotlin/com/esuiss/ui/theme/Theme.kt)

- `kotlin/theme/Tokens.kt`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/kotlin/ui/src/main/kotlin/com/esuiss/ui/theme/Tokens.kt)

3. Copy the source and every file it uses:

```kt title="kotlin/components/Carousel.kt"
package com.esuiss.ui.components

import androidx.compose.animation.animateColorAsState
import androidx.compose.animation.core.Animatable
import androidx.compose.animation.core.CubicBezierEasing
import androidx.compose.animation.core.LinearEasing
import androidx.compose.animation.core.animateDpAsState
import androidx.compose.animation.core.tween
import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.interaction.collectIsDraggedAsState
import androidx.compose.foundation.interaction.collectIsPressedAsState
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxScope
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.ColumnScope
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.RowScope
import androidx.compose.foundation.layout.fillMaxHeight
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.pager.HorizontalPager
import androidx.compose.foundation.pager.PagerState
import androidx.compose.foundation.pager.VerticalPager
import androidx.compose.foundation.pager.rememberPagerState
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.Stable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.rememberUpdatedState
import androidx.compose.runtime.setValue
import androidx.compose.runtime.snapshotFlow
import androidx.compose.runtime.staticCompositionLocalOf
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.draw.drawBehind
import androidx.compose.ui.geometry.CornerRadius
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.semantics.Role
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.selected
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.adamglin.PhosphorIcons
import com.adamglin.phosphoricons.Fill
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.fill.Pause
import com.adamglin.phosphoricons.fill.Play
import com.adamglin.phosphoricons.regular.CaretDown
import com.adamglin.phosphoricons.regular.CaretLeft
import com.adamglin.phosphoricons.regular.CaretRight
import com.adamglin.phosphoricons.regular.CaretUp
import com.esuiss.ui.theme.EsuissTheme
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.flow.distinctUntilChanged
import kotlinx.coroutines.flow.drop
import kotlinx.coroutines.launch

enum class CarouselOrientation { Horizontal, Vertical }

enum class CarouselDotsVariant { Default, Plain }

internal val CarouselEasing = CubicBezierEasing(0.32f, 0.72f, 0f, 1f)

@Stable
class CarouselState internal constructor(
    internal val pager: PagerState,
    private val scope: CoroutineScope,
    val loop: Boolean,
) {
    val pageCount: Int get() = pager.pageCount

    val selectedIndex: Int get() = pager.currentPage

    val canScrollPrev: Boolean get() = pageCount > 1 && (loop || selectedIndex > 0)

    val canScrollNext: Boolean get() = pageCount > 1 && (loop || selectedIndex < pageCount - 1)

    internal var autoplayEnabled by mutableStateOf(false)

    internal var playing by mutableStateOf(false)

    internal val progress = Animatable(0f)

    fun scrollTo(index: Int, animate: Boolean = true) {
        if (pageCount == 0) return
        val target = index.coerceIn(0, pageCount - 1)
        scope.launch {
            if (animate) pager.animateScrollToPage(target, animationSpec = tween(500, easing = CarouselEasing))
            else pager.scrollToPage(target)
        }
    }

    fun scrollPrev() {
        if (!canScrollPrev) return
        scrollTo(if (selectedIndex == 0) pageCount - 1 else selectedIndex - 1)
    }

    fun scrollNext() {
        if (!canScrollNext) return
        scrollTo(if (selectedIndex == pageCount - 1) 0 else selectedIndex + 1)
    }

    fun setPlaying(playing: Boolean) {
        this.playing = playing
    }

    val isPlaying: Boolean get() = autoplayEnabled && playing
}

@Composable
fun rememberCarouselState(pageCount: Int, initialPage: Int = 0, loop: Boolean = false): CarouselState {
    val pager = rememberPagerState(initialPage) { pageCount }
    val scope = rememberCoroutineScope()
    return remember(pager, scope, loop) { CarouselState(pager, scope, loop) }
}

@Stable
private class CarouselContext(val state: CarouselState, val orientation: CarouselOrientation)

private val LocalCarousel = staticCompositionLocalOf<CarouselContext?> { null }

@Composable
private fun carousel(): CarouselContext =
    checkNotNull(LocalCarousel.current) { "Carousel parts must be used within a Carousel" }

@Composable
fun Carousel(
    state: CarouselState,
    modifier: Modifier = Modifier,
    orientation: CarouselOrientation = CarouselOrientation.Horizontal,
    autoplay: Boolean = false,
    autoplayDelayMillis: Long = 5000L,
    onSelect: ((Int) -> Unit)? = null,
    content: @Composable ColumnScope.() -> Unit,
) {
    val select by rememberUpdatedState(onSelect)
    LaunchedEffect(state) {
        snapshotFlow { state.selectedIndex }.distinctUntilChanged().drop(1).collect { select?.invoke(it) }
    }
    LaunchedEffect(state, autoplay) {
        state.autoplayEnabled = autoplay
        state.playing = autoplay
    }
    val dragged by state.pager.interactionSource.collectIsDraggedAsState()
    val running = state.autoplayEnabled && state.playing && !dragged
    val selected = state.selectedIndex
    LaunchedEffect(selected) { state.progress.snapTo(0f) }
    LaunchedEffect(state, running, selected, autoplayDelayMillis) {
        if (!running) return@LaunchedEffect
        val remaining = (autoplayDelayMillis * (1f - state.progress.value)).toInt().coerceAtLeast(0)
        state.progress.animateTo(1f, tween(remaining, easing = LinearEasing))
        if (state.selectedIndex != selected) return@LaunchedEffect
        if (state.selectedIndex < state.pageCount - 1) state.scrollTo(state.selectedIndex + 1) else state.scrollTo(0)
    }
    CompositionLocalProvider(LocalCarousel provides remember(state, orientation) { CarouselContext(state, orientation) }) {
        Column(modifier = modifier, content = content)
    }
}

@Composable
fun CarouselContent(
    modifier: Modifier = Modifier,
    contentPadding: PaddingValues = PaddingValues(0.dp),
    pageSpacing: Dp = 16.dp,
    key: ((Int) -> Any)? = null,
    content: @Composable (page: Int) -> Unit,
) {
    val context = carousel()
    if (context.orientation == CarouselOrientation.Horizontal) {
        HorizontalPager(
            state = context.state.pager,
            modifier = modifier.fillMaxWidth(),
            contentPadding = contentPadding,
            pageSpacing = pageSpacing,
            key = key,
            verticalAlignment = Alignment.Top,
        ) { page -> content(page) }
    } else {
        VerticalPager(
            state = context.state.pager,
            modifier = modifier,
            contentPadding = contentPadding,
            pageSpacing = pageSpacing,
            key = key,
            horizontalAlignment = Alignment.Start,
        ) { page -> content(page) }
    }
}

@Composable
fun CarouselItem(
    modifier: Modifier = Modifier,
    content: @Composable BoxScope.() -> Unit,
) {
    Box(modifier = modifier, content = content)
}

@Composable
fun CarouselPrevious(
    modifier: Modifier = Modifier,
    variant: ButtonVariant = ButtonVariant.Secondary,
    size: ButtonSize = ButtonSize.Icon,
    contentDescription: String = "Previous slide",
) {
    val context = carousel()
    Button(
        onClick = { context.state.scrollPrev() },
        modifier = modifier,
        variant = variant,
        size = size,
        enabled = context.state.canScrollPrev,
    ) {
        Icon(
            if (context.orientation == CarouselOrientation.Horizontal) PhosphorIcons.Regular.CaretLeft else PhosphorIcons.Regular.CaretUp,
            contentDescription = contentDescription,
        )
    }
}

@Composable
fun CarouselNext(
    modifier: Modifier = Modifier,
    variant: ButtonVariant = ButtonVariant.Secondary,
    size: ButtonSize = ButtonSize.Icon,
    contentDescription: String = "Next slide",
) {
    val context = carousel()
    Button(
        onClick = { context.state.scrollNext() },
        modifier = modifier,
        variant = variant,
        size = size,
        enabled = context.state.canScrollNext,
    ) {
        Icon(
            if (context.orientation == CarouselOrientation.Horizontal) PhosphorIcons.Regular.CaretRight else PhosphorIcons.Regular.CaretDown,
            contentDescription = contentDescription,
        )
    }
}

@Composable
fun CarouselControls(
    modifier: Modifier = Modifier,
    content: @Composable RowScope.() -> Unit,
) {
    Row(
        modifier = modifier.padding(top = 24.dp),
        horizontalArrangement = Arrangement.spacedBy(12.dp),
        verticalAlignment = Alignment.CenterVertically,
        content = content,
    )
}

@Composable
fun CarouselDots(
    modifier: Modifier = Modifier,
    variant: CarouselDotsVariant = CarouselDotsVariant.Default,
) {
    val context = carousel()
    val state = context.state
    val colors = EsuissTheme.colors
    val plain = variant == CarouselDotsVariant.Plain
    Row(
        modifier = modifier
            .height(36.dp)
            .clip(CircleShape)
            .background(if (plain) Color.Transparent else colors.secondary, CircleShape)
            .padding(horizontal = if (plain) 0.dp else 8.dp),
        verticalAlignment = Alignment.CenterVertically,
    ) {
        for (index in 0 until state.pageCount) {
            val active = index == state.selectedIndex
            val interaction = remember { MutableInteractionSource() }
            val pressed by interaction.collectIsPressedAsState()
            val width by animateDpAsState(if (active) 24.dp else 8.dp, tween(500, easing = CarouselEasing), label = "dot")
            val target = when {
                active && !state.autoplayEnabled -> colors.foreground
                pressed -> colors.mutedForeground
                else -> colors.mutedForeground
            }
            val color by animateColorAsState(target, tween(500, easing = CarouselEasing), label = "dotColor")
            val fill = colors.foreground
            Box(
                modifier = Modifier
                    .fillMaxHeight()
                    .clickable(interactionSource = interaction, indication = null, role = Role.Button) { state.scrollTo(index) }
                    .semantics {
                        contentDescription = "Go to slide ${index + 1}"
                        selected = active
                    }
                    .padding(horizontal = 8.dp),
                contentAlignment = Alignment.Center,
            ) {
                Box(
                    modifier = Modifier
                        .width(width)
                        .height(8.dp)
                        .clip(CircleShape)
                        .background(color, CircleShape)
                        .then(
                            if (active && state.autoplayEnabled) {
                                Modifier.drawBehind {
                                    val fraction = if (state.playing) state.progress.value else 1f
                                    drawRoundRect(
                                        color = fill,
                                        size = size.copy(width = size.width * fraction),
                                        cornerRadius = CornerRadius(size.height / 2f),
                                    )
                                }
                            } else {
                                Modifier
                            },
                        ),
                )
            }
        }
    }
}

@Composable
fun CarouselPlayButton(
    modifier: Modifier = Modifier,
    variant: ButtonVariant = ButtonVariant.Secondary,
    size: ButtonSize = ButtonSize.IconSm,
) {
    val state = carousel().state
    if (!state.autoplayEnabled) return
    Button(
        onClick = { state.setPlaying(!state.playing) },
        modifier = modifier,
        variant = variant,
        size = size,
    ) {
        Icon(
            if (state.playing) PhosphorIcons.Fill.Pause else PhosphorIcons.Fill.Play,
            contentDescription = if (state.playing) "Pause slideshow" else "Play slideshow",
        )
    }
}
```

- `kotlin/components/Button.kt`: see [Button](https://ui.suiss.app/docs/components/button.md)

- `kotlin/components/ButtonGroup.kt`: see [Button Group](https://ui.suiss.app/docs/components/button-group.md)

- `kotlin/components/Content.kt`: [source](https://github.com/e-suiss/ui/blob/main/packages/mobile/kotlin/ui/src/main/kotlin/com/esuiss/ui/components/Content.kt)

- `kotlin/components/Icon.kt`: see [Icon](https://ui.suiss.app/docs/components/icon.md)

4. Update the `com.esuiss.ui` package names to match your project.

## Usage

```tsx
import { Carousel, CarouselContent, CarouselItem, CarouselPrevious, CarouselNext, CarouselControls, CarouselDots, CarouselPlayButton } from "@/components/ui/carousel"
```

```tsx
<View className="mx-12">
  <Carousel>
    <NumberSlides />
    <CarouselPrevious />
    <CarouselNext />
  </Carousel>
</View>
```

Set each slide's width with `basis` on `CarouselItem`, as a fraction of the viewport (for example `0.5` for two per view). Use `opts` for `loop`, `align` (`start` or `center`) and `dragFree` scrolling without snapping.

Pass `autoplay` as `true` for the default 5-second delay, or as a number of milliseconds. Put `CarouselDots`, `CarouselPlayButton` and nav buttons inside `CarouselControls` to show them in a row below the slides; `CarouselDots` takes `variant="plain"` to drop its background.

Use `setApi` to get a `CarouselApi` for scrolling from outside, or call `useCarousel()` inside the carousel to read the selected index and scroll state.

## Examples

### Multiple items

Two slides per view with `basis={0.5}`.

![Preview](https://ui.suiss.app/previews/components-carousel--multiple-items.light.webp)

```tsx
import { View } from "react-native"
import { Card, CardContent } from "@/components/ui/card"
import { Carousel, CarouselContent, CarouselItem, CarouselNext, CarouselPrevious } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const slides = [1, 2, 3, 4, 5]

function NumberSlides({ basis }: { basis?: number }) {
  return (
    <CarouselContent>
      {slides.map((slide) => (
        <CarouselItem key={slide} basis={basis}>
          <Card size={basis ? "sm" : "default"}>
            <CardContent className="aspect-square items-center justify-center">
              <Text className="text-4xl font-semibold">{slide}</Text>
            </CardContent>
          </Card>
        </CarouselItem>
      ))}
    </CarouselContent>
  )
}

export function CarouselMultipleItemsExample() {
  return (
    <View className="mx-12">
      <Carousel opts={{ align: "start" }}>
        <NumberSlides basis={0.5} />
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselMultipleItemsExample: View {
  var body: some View {
    Carousel {
      HStack(spacing: 12) {
        CarouselPrevious()
        CarouselNumberSlides(basis: 0.5)
        CarouselNext()
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselNumberSlides: View {
  let basis: CGFloat?

  var body: some View {
    CarouselContent {
      ForEach(CarouselData.slides, id: \.self) { slide in
        CarouselItem(basis: basis ?? 1) {
          Card(size: basis == nil ? .default : .sm) {
            CardContent {
              Text(verbatim: "\(slide)")
                .textStyle(.xl3, weight: .semibold)
                .frame(maxWidth: .infinity, maxHeight: .infinity)
                .aspectRatio(1, contentMode: .fit)
            }
          }
        }
      }
    }
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Card
import com.esuiss.ui.components.CardContent
import com.esuiss.ui.components.CardSize
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselNext
import com.esuiss.ui.components.CarouselPrevious
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Typography

@Composable
fun CarouselMultipleItemsExample() {
    CarouselNumbers(basis = 0.5f, loop = false)
}

val carouselSlides = listOf(1, 2, 3, 4, 5)

val carouselSpacing = 16.dp

fun carouselPeek(width: Dp, basis: Float?, spacing: Dp = carouselSpacing): PaddingValues {
    if (basis == null) return PaddingValues(0.dp)
    val page = (width + spacing) * basis - spacing
    return PaddingValues(end = width - page)
}

@Composable
fun CarouselNumbers(basis: Float?, loop: Boolean) {
    val state = rememberCarouselState(pageCount = carouselSlides.size, loop = loop)
    BoxWithConstraints(Modifier.fillMaxWidth()) {
        val width = maxWidth
        Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
            CarouselContent(contentPadding = carouselPeek(width, basis)) { page ->
                CarouselItem {
                    Card(size = if (basis != null) CardSize.Sm else CardSize.Default) {
                        CardContent {
                            Box(Modifier.fillMaxWidth().aspectRatio(1f), contentAlignment = Alignment.Center) {
                                Text(
                                    carouselSlides[page].toString(),
                                    style = Typography.xl3.copy(fontWeight = FontWeight.SemiBold),
                                )
                            }
                        }
                    }
                }
            }
            Row(
                Modifier.fillMaxWidth().padding(top = 12.dp),
                horizontalArrangement = Arrangement.SpaceBetween,
                verticalAlignment = Alignment.CenterVertically,
            ) {
                CarouselPrevious()
                CarouselNext()
            }
        }
    }
}
```

### Loop

Wraps around from the last slide to the first.

![Preview](https://ui.suiss.app/previews/components-carousel--loop.light.webp)

```tsx
import { View } from "react-native"
import { Card, CardContent } from "@/components/ui/card"
import { Carousel, CarouselContent, CarouselItem, CarouselNext, CarouselPrevious } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const slides = [1, 2, 3, 4, 5]

function NumberSlides({ basis }: { basis?: number }) {
  return (
    <CarouselContent>
      {slides.map((slide) => (
        <CarouselItem key={slide} basis={basis}>
          <Card size={basis ? "sm" : "default"}>
            <CardContent className="aspect-square items-center justify-center">
              <Text className="text-4xl font-semibold">{slide}</Text>
            </CardContent>
          </Card>
        </CarouselItem>
      ))}
    </CarouselContent>
  )
}

export function CarouselLoopExample() {
  return (
    <View className="mx-12">
      <Carousel opts={{ loop: true }}>
        <NumberSlides />
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselLoopExample: View {
  var body: some View {
    Carousel(loop: true) {
      HStack(spacing: 12) {
        CarouselPrevious()
        CarouselNumberSlides(basis: nil)
        CarouselNext()
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselNumberSlides: View {
  let basis: CGFloat?

  var body: some View {
    CarouselContent {
      ForEach(CarouselData.slides, id: \.self) { slide in
        CarouselItem(basis: basis ?? 1) {
          Card(size: basis == nil ? .default : .sm) {
            CardContent {
              Text(verbatim: "\(slide)")
                .textStyle(.xl3, weight: .semibold)
                .frame(maxWidth: .infinity, maxHeight: .infinity)
                .aspectRatio(1, contentMode: .fit)
            }
          }
        }
      }
    }
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Card
import com.esuiss.ui.components.CardContent
import com.esuiss.ui.components.CardSize
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselNext
import com.esuiss.ui.components.CarouselPrevious
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Typography

@Composable
fun CarouselLoopExample() {
    CarouselNumbers(basis = null, loop = true)
}

val carouselSlides = listOf(1, 2, 3, 4, 5)

val carouselSpacing = 16.dp

fun carouselPeek(width: Dp, basis: Float?, spacing: Dp = carouselSpacing): PaddingValues {
    if (basis == null) return PaddingValues(0.dp)
    val page = (width + spacing) * basis - spacing
    return PaddingValues(end = width - page)
}

@Composable
fun CarouselNumbers(basis: Float?, loop: Boolean) {
    val state = rememberCarouselState(pageCount = carouselSlides.size, loop = loop)
    BoxWithConstraints(Modifier.fillMaxWidth()) {
        val width = maxWidth
        Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
            CarouselContent(contentPadding = carouselPeek(width, basis)) { page ->
                CarouselItem {
                    Card(size = if (basis != null) CardSize.Sm else CardSize.Default) {
                        CardContent {
                            Box(Modifier.fillMaxWidth().aspectRatio(1f), contentAlignment = Alignment.Center) {
                                Text(
                                    carouselSlides[page].toString(),
                                    style = Typography.xl3.copy(fontWeight = FontWeight.SemiBold),
                                )
                            }
                        }
                    }
                }
            }
            Row(
                Modifier.fillMaxWidth().padding(top = 12.dp),
                horizontalArrangement = Arrangement.SpaceBetween,
                verticalAlignment = Alignment.CenterVertically,
            ) {
                CarouselPrevious()
                CarouselNext()
            }
        }
    }
}
```

### Vertical

A vertical carousel with arrows above and below.

![Preview](https://ui.suiss.app/previews/components-carousel--vertical.light.webp)

```tsx
import { View } from "react-native"
import { Card, CardContent } from "@/components/ui/card"
import { Carousel, CarouselContent, CarouselItem, CarouselNext, CarouselPrevious } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const slides = [1, 2, 3, 4, 5]

export function CarouselVerticalExample() {
  return (
    <View className="my-12">
      <Carousel orientation="vertical" opts={{ align: "start" }}>
        <CarouselContent className="h-64">
          {slides.map((slide) => (
            <CarouselItem key={slide} basis={0.5}>
              <Card size="sm" className="h-full justify-center">
                <CardContent className="items-center justify-center">
                  <Text className="text-3xl font-semibold">{slide}</Text>
                </CardContent>
              </Card>
            </CarouselItem>
          ))}
        </CarouselContent>
        <CarouselPrevious />
        <CarouselNext />
      </Carousel>
    </View>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselVerticalExample: View {
  var body: some View {
    Carousel(orientation: .vertical) {
      VStack(spacing: 12) {
        CarouselPrevious()
        CarouselContent {
          ForEach(CarouselData.slides, id: \.self) { slide in
            CarouselItem(basis: 0.5) {
              Card(size: .sm) {
                CardContent {
                  Text(verbatim: "\(slide)")
                    .textStyle(.xl2, weight: .semibold)
                    .frame(maxWidth: .infinity, maxHeight: .infinity)
                }
              }
            }
          }
        }
        .frame(height: 256)
        CarouselNext()
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxHeight
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Card
import com.esuiss.ui.components.CardSize
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselNext
import com.esuiss.ui.components.CarouselOrientation
import com.esuiss.ui.components.CarouselPrevious
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Typography

val carouselSlides = listOf(1, 2, 3, 4, 5)

val carouselSpacing = 16.dp

@Composable
fun CarouselVertical() {
    val state = rememberCarouselState(pageCount = carouselSlides.size)
    val height = 256.dp
    val spacing = carouselSpacing
    Carousel(state = state, modifier = Modifier.fillMaxWidth(), orientation = CarouselOrientation.Vertical) {
        CarouselContent(
            modifier = Modifier.fillMaxWidth().height(height),
            contentPadding = PaddingValues(bottom = height - ((height + spacing) * 0.5f - spacing)),
        ) { page ->
            CarouselItem(Modifier.fillMaxWidth().fillMaxHeight()) {
                Card(modifier = Modifier.fillMaxHeight(), size = CardSize.Sm) {
                    Box(Modifier.fillMaxWidth().weight(1f), contentAlignment = Alignment.Center) {
                        Text(
                            carouselSlides[page].toString(),
                            style = Typography.xl3.copy(fontWeight = FontWeight.SemiBold),
                        )
                    }
                }
            }
        }
        Row(
            Modifier.fillMaxWidth().padding(top = 12.dp),
            horizontalArrangement = Arrangement.SpaceBetween,
            verticalAlignment = Alignment.CenterVertically,
        ) {
            CarouselPrevious()
            CarouselNext()
        }
    }
}
```

### With page indicator

Full-width cards with a page indicator below.

![Preview](https://ui.suiss.app/previews/components-carousel--with-page-indicator.light.webp)

```tsx
import { View } from "react-native"
import { Carousel, CarouselContent, CarouselItem, useCarousel } from "@/components/ui/carousel"
import { PageIndicator } from "@/components/ui/page-indicator"
import { Text } from "@/components/ui/text"

const picks = [
  {
    eyebrow: "Today's pick",
    title: "Weekend breakfast",
    tint: "bg-orange-500",
  },
  { eyebrow: "New", title: "Grilled meatballs", tint: "bg-red-500" },
  { eyebrow: "Chef's special", title: "Lentil soup", tint: "bg-teal-500" },
  { eyebrow: "Dessert", title: "Künefe", tint: "bg-purple-500" },
]

function CarouselPageIndicator() {
  const { scrollSnaps, selectedIndex, scrollTo } = useCarousel()
  return (
    <PageIndicator
      className="mt-4"
      count={scrollSnaps.length}
      index={selectedIndex}
      onIndexChange={(index) => scrollTo(index)}
    />
  )
}

export function CarouselWithPageIndicatorExample() {
  return (
    <Carousel>
      <CarouselContent>
        {picks.map((pick) => (
          <CarouselItem key={pick.title}>
            <View
              className={`aspect-[4/5] justify-end gap-1 rounded-3xl p-5 ${pick.tint}`}
            >
              <Text className="text-xs font-semibold text-primary-foreground uppercase">
                {pick.eyebrow}
              </Text>
              <Text className="text-2xl font-bold text-primary-foreground">
                {pick.title}
              </Text>
            </View>
          </CarouselItem>
        ))}
      </CarouselContent>
      <CarouselPageIndicator />
    </Carousel>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselPickCard: View {
  let pick: CarouselPick

  var body: some View {
    VStack(alignment: .leading, spacing: 4) {
      Text(verbatim: pick.eyebrow.uppercased())
        .textStyle(.xs, weight: .semibold)
      Text(verbatim: pick.title)
        .textStyle(.xl2, weight: .bold)
    }
    .foregroundStyle(EsuissColor.primaryForeground)
    .padding(20)
    .frame(maxWidth: .infinity, maxHeight: .infinity, alignment: .bottomLeading)
    .aspectRatio(4.0 / 5.0, contentMode: .fit)
    .background(pick.tint, in: RoundedRectangle(cornerRadius: Radius.xl3, style: .continuous))
  }
}

struct CarouselPageIndicatorDemo: View {
  @State private var controller = CarouselController()

  var body: some View {
    Carousel(controller: controller) {
      CarouselContent {
        ForEach(CarouselData.picks, id: \.title) { pick in
          CarouselItem {
            CarouselPickCard(pick: pick)
          }
        }
      }
      PageIndicator(count: controller.count, index: controller.selectedIndex) { controller.scrollTo($0) }
        .padding(.top, 16)
    }
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.PageIndicator
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Colors
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Palette
import com.esuiss.ui.theme.Radius
import com.esuiss.ui.theme.Typography

class CarouselPick(val eyebrow: String, val title: String, val tint: (Colors) -> Color)

val carouselPicks = listOf(
    CarouselPick("Today's pick", "Weekend breakfast") { Palette.orange500 },
    CarouselPick("New", "Grilled meatballs") { Palette.red500 },
    CarouselPick("Chef's special", "Lentil soup") { Palette.teal500 },
    CarouselPick("Dessert", "Künefe") { Palette.purple500 },
)

@Composable
fun CarouselPickCard(pick: CarouselPick) {
    val colors = EsuissTheme.colors
    Column(
        Modifier
            .fillMaxWidth()
            .aspectRatio(4f / 5f)
            .clip(RoundedCornerShape(Radius.xl3))
            .background(pick.tint(colors))
            .padding(20.dp),
        verticalArrangement = Arrangement.spacedBy(4.dp, Alignment.Bottom),
    ) {
        Text(
            pick.eyebrow.uppercase(),
            style = Typography.xs.copy(color = colors.primaryForeground, fontWeight = FontWeight.SemiBold),
        )
        Text(
            pick.title,
            style = Typography.xl2.copy(color = colors.primaryForeground, fontWeight = FontWeight.Bold),
        )
    }
}

@Composable
fun CarouselWithPageIndicator() {
    val state = rememberCarouselState(pageCount = carouselPicks.size)
    Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
        CarouselContent { page ->
            CarouselItem { CarouselPickCard(carouselPicks[page]) }
        }
        PageIndicator(
            count = state.pageCount,
            index = state.selectedIndex,
            modifier = Modifier.padding(top = 16.dp).align(Alignment.CenterHorizontally),
            onIndexChange = { state.scrollTo(it) },
        )
    }
}
```

### Featured

Peeking cards with plain dots and a play button.

![Preview](https://ui.suiss.app/previews/components-carousel--featured.light.webp)

```tsx
import { View } from "react-native"
import { Carousel, CarouselContent, CarouselControls, CarouselDots, CarouselItem, CarouselPlayButton } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const picks = [
  {
    eyebrow: "Today's pick",
    title: "Weekend breakfast",
    tint: "bg-orange-500",
  },
  { eyebrow: "New", title: "Grilled meatballs", tint: "bg-red-500" },
  { eyebrow: "Chef's special", title: "Lentil soup", tint: "bg-teal-500" },
  { eyebrow: "Dessert", title: "Künefe", tint: "bg-purple-500" },
]

export function CarouselFeaturedExample() {
  return (
    <Carousel opts={{ align: "start" }}>
      <CarouselContent>
        {picks.map((pick) => (
          <CarouselItem key={pick.title} basis={0.88}>
            <View
              className={`aspect-[4/5] justify-end gap-1 rounded-3xl p-5 ${pick.tint}`}
            >
              <Text className="text-xs font-semibold text-primary-foreground uppercase">
                {pick.eyebrow}
              </Text>
              <Text className="text-2xl font-bold text-primary-foreground">
                {pick.title}
              </Text>
            </View>
          </CarouselItem>
        ))}
      </CarouselContent>
      <CarouselControls className="mt-4 justify-center">
        <CarouselDots variant="plain" />
        <CarouselPlayButton variant="ghost" />
      </CarouselControls>
    </Carousel>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselFeaturedExample: View {
  var body: some View {
    Carousel {
      CarouselContent {
        ForEach(CarouselData.picks, id: \.title) { pick in
          CarouselItem(basis: 0.88) {
            CarouselPickCard(pick: pick)
          }
        }
      }
      CarouselControls {
        CarouselDots(variant: .plain)
        CarouselPlayButton(variant: .ghost)
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselPickCard: View {
  let pick: CarouselPick

  var body: some View {
    VStack(alignment: .leading, spacing: 4) {
      Text(verbatim: pick.eyebrow.uppercased())
        .textStyle(.xs, weight: .semibold)
      Text(verbatim: pick.title)
        .textStyle(.xl2, weight: .bold)
    }
    .foregroundStyle(EsuissColor.primaryForeground)
    .padding(20)
    .frame(maxWidth: .infinity, maxHeight: .infinity, alignment: .bottomLeading)
    .aspectRatio(4.0 / 5.0, contentMode: .fit)
    .background(pick.tint, in: RoundedRectangle(cornerRadius: Radius.xl3, style: .continuous))
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.ButtonVariant
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselControls
import com.esuiss.ui.components.CarouselDots
import com.esuiss.ui.components.CarouselDotsVariant
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselPlayButton
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Colors
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Palette
import com.esuiss.ui.theme.Radius
import com.esuiss.ui.theme.Typography

class CarouselPick(val eyebrow: String, val title: String, val tint: (Colors) -> Color)

val carouselPicks = listOf(
    CarouselPick("Today's pick", "Weekend breakfast") { Palette.orange500 },
    CarouselPick("New", "Grilled meatballs") { Palette.red500 },
    CarouselPick("Chef's special", "Lentil soup") { Palette.teal500 },
    CarouselPick("Dessert", "Künefe") { Palette.purple500 },
)

val carouselSpacing = 16.dp

fun carouselPeek(width: Dp, basis: Float?, spacing: Dp = carouselSpacing): PaddingValues {
    if (basis == null) return PaddingValues(0.dp)
    val page = (width + spacing) * basis - spacing
    return PaddingValues(end = width - page)
}

@Composable
fun CarouselPickCard(pick: CarouselPick) {
    val colors = EsuissTheme.colors
    Column(
        Modifier
            .fillMaxWidth()
            .aspectRatio(4f / 5f)
            .clip(RoundedCornerShape(Radius.xl3))
            .background(pick.tint(colors))
            .padding(20.dp),
        verticalArrangement = Arrangement.spacedBy(4.dp, Alignment.Bottom),
    ) {
        Text(
            pick.eyebrow.uppercase(),
            style = Typography.xs.copy(color = colors.primaryForeground, fontWeight = FontWeight.SemiBold),
        )
        Text(
            pick.title,
            style = Typography.xl2.copy(color = colors.primaryForeground, fontWeight = FontWeight.Bold),
        )
    }
}

@Composable
fun CarouselFeatured() {
    val state = rememberCarouselState(pageCount = carouselPicks.size)
    BoxWithConstraints(Modifier.fillMaxWidth()) {
        val width = maxWidth
        Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
            CarouselContent(contentPadding = carouselPeek(width, 0.88f)) { page ->
                CarouselItem { CarouselPickCard(carouselPicks[page]) }
            }
            CarouselControls(Modifier.align(Alignment.CenterHorizontally)) {
                CarouselDots(variant = CarouselDotsVariant.Plain)
                CarouselPlayButton(variant = ButtonVariant.Ghost)
            }
        }
    }
}
```

### Spotlight

A looping showcase with dots and an inline next button.

![Preview](https://ui.suiss.app/previews/components-carousel--spotlight.light.webp)

```tsx
import { View } from "react-native"
import { Carousel, CarouselContent, CarouselControls, CarouselDots, CarouselItem, CarouselNext } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const features = [
  { title: "Take orders at the table." },
  { title: "Every ticket, right on time." },
  { title: "A full room, every night." },
]

export function CarouselSpotlightExample() {
  return (
    <Carousel opts={{ loop: true }}>
      <CarouselContent>
        {features.map((feature) => (
          <CarouselItem key={feature.title}>
            <View className="aspect-[10/7] items-center justify-center gap-3 rounded-3xl bg-muted p-8">
              <Text className="text-3xl font-bold">Hestia POS</Text>
              <Text className="text-center text-muted-foreground">
                {feature.title}
              </Text>
            </View>
          </CarouselItem>
        ))}
      </CarouselContent>
      <CarouselControls className="justify-center">
        <CarouselDots />
        <CarouselNext size="icon-sm" />
      </CarouselControls>
    </Carousel>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselSpotlightExample: View {
  var body: some View {
    Carousel(loop: true) {
      CarouselFeatureSlides()
      CarouselControls {
        CarouselDots()
        CarouselNext(size: .iconSm)
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselFeatureSlides: View {
  var body: some View {
    CarouselContent {
      ForEach(CarouselData.features, id: \.self) { feature in
        CarouselItem {
          VStack(spacing: 12) {
            Text(verbatim: "Hestia POS")
              .textStyle(.xl2, weight: .bold)
              .foregroundStyle(EsuissColor.foreground)
            Text(verbatim: feature)
              .textStyle(.base)
              .foregroundStyle(EsuissColor.mutedForeground)
              .multilineTextAlignment(.center)
          }
          .padding(32)
          .frame(maxWidth: .infinity, maxHeight: .infinity)
          .aspectRatio(10.0 / 7.0, contentMode: .fit)
          .background(EsuissColor.muted, in: RoundedRectangle(cornerRadius: Radius.xl3, style: .continuous))
        }
      }
    }
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.ButtonSize
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselControls
import com.esuiss.ui.components.CarouselDots
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselNext
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Radius
import com.esuiss.ui.theme.Typography

val carouselFeatures = listOf(
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
)

@Composable
fun CarouselFeatureCard(title: String) {
    val colors = EsuissTheme.colors
    Column(
        Modifier
            .fillMaxWidth()
            .aspectRatio(10f / 7f)
            .clip(RoundedCornerShape(Radius.xl3))
            .background(colors.muted)
            .padding(32.dp),
        verticalArrangement = Arrangement.spacedBy(12.dp, Alignment.CenterVertically),
        horizontalAlignment = Alignment.CenterHorizontally,
    ) {
        Text("Hestia POS", style = Typography.xl3.copy(fontWeight = FontWeight.Bold))
        Text(title, style = Typography.base.copy(color = colors.mutedForeground), textAlign = TextAlign.Center)
    }
}

@Composable
fun CarouselSpotlight() {
    val state = rememberCarouselState(pageCount = carouselFeatures.size, loop = true)
    Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
        CarouselContent { page ->
            CarouselItem { CarouselFeatureCard(carouselFeatures[page]) }
        }
        CarouselControls(Modifier.align(Alignment.CenterHorizontally)) {
            CarouselDots()
            CarouselNext(size = ButtonSize.IconSm)
        }
    }
}
```

### Autoplay

Advances every four seconds, with progress dots and a play button.

![Preview](https://ui.suiss.app/previews/components-carousel--autoplay.light.webp)

```tsx
import { View } from "react-native"
import { Carousel, CarouselContent, CarouselControls, CarouselDots, CarouselItem, CarouselPlayButton } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const features = [
  { title: "Take orders at the table." },
  { title: "Every ticket, right on time." },
  { title: "A full room, every night." },
]

export function CarouselAutoplayExample() {
  return (
    <Carousel autoplay={4000} opts={{ loop: true }}>
      <CarouselContent>
        {features.map((feature) => (
          <CarouselItem key={feature.title}>
            <View className="aspect-[10/7] items-center justify-center gap-3 rounded-3xl bg-muted p-8">
              <Text className="text-3xl font-bold">Hestia POS</Text>
              <Text className="text-center text-muted-foreground">
                {feature.title}
              </Text>
            </View>
          </CarouselItem>
        ))}
      </CarouselContent>
      <CarouselControls className="justify-center">
        <CarouselDots />
        <CarouselPlayButton />
      </CarouselControls>
    </Carousel>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselAutoplayExample: View {
  var body: some View {
    Carousel(loop: true, autoplay: .seconds(4)) {
      CarouselFeatureSlides()
      CarouselControls {
        CarouselDots()
        CarouselPlayButton()
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

struct CarouselFeatureSlides: View {
  var body: some View {
    CarouselContent {
      ForEach(CarouselData.features, id: \.self) { feature in
        CarouselItem {
          VStack(spacing: 12) {
            Text(verbatim: "Hestia POS")
              .textStyle(.xl2, weight: .bold)
              .foregroundStyle(EsuissColor.foreground)
            Text(verbatim: feature)
              .textStyle(.base)
              .foregroundStyle(EsuissColor.mutedForeground)
              .multilineTextAlignment(.center)
          }
          .padding(32)
          .frame(maxWidth: .infinity, maxHeight: .infinity)
          .aspectRatio(10.0 / 7.0, contentMode: .fit)
          .background(EsuissColor.muted, in: RoundedRectangle(cornerRadius: Radius.xl3, style: .continuous))
        }
      }
    }
  }
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselControls
import com.esuiss.ui.components.CarouselDots
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.CarouselPlayButton
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Radius
import com.esuiss.ui.theme.Typography

val carouselFeatures = listOf(
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
)

@Composable
fun CarouselFeatureCard(title: String) {
    val colors = EsuissTheme.colors
    Column(
        Modifier
            .fillMaxWidth()
            .aspectRatio(10f / 7f)
            .clip(RoundedCornerShape(Radius.xl3))
            .background(colors.muted)
            .padding(32.dp),
        verticalArrangement = Arrangement.spacedBy(12.dp, Alignment.CenterVertically),
        horizontalAlignment = Alignment.CenterHorizontally,
    ) {
        Text("Hestia POS", style = Typography.xl3.copy(fontWeight = FontWeight.Bold))
        Text(title, style = Typography.base.copy(color = colors.mutedForeground), textAlign = TextAlign.Center)
    }
}

@Composable
fun CarouselAutoplay() {
    val state = rememberCarouselState(pageCount = carouselFeatures.size, loop = true)
    Carousel(state = state, modifier = Modifier.fillMaxWidth(), autoplay = true, autoplayDelayMillis = 4000L) {
        CarouselContent { page ->
            CarouselItem { CarouselFeatureCard(carouselFeatures[page]) }
        }
        CarouselControls(Modifier.align(Alignment.CenterHorizontally)) {
            CarouselDots()
            CarouselPlayButton()
        }
    }
}
```

### Shelf

A free-scrolling shelf of small cards with `dragFree`.

![Preview](https://ui.suiss.app/previews/components-carousel--shelf.light.webp)

```tsx
import { View } from "react-native"
import { Carousel, CarouselContent, CarouselItem } from "@/components/ui/carousel"
import { Text } from "@/components/ui/text"

const picks = [
  {
    eyebrow: "Today's pick",
    title: "Weekend breakfast",
    tint: "bg-orange-500",
  },
  { eyebrow: "New", title: "Grilled meatballs", tint: "bg-red-500" },
  { eyebrow: "Chef's special", title: "Lentil soup", tint: "bg-teal-500" },
  { eyebrow: "Dessert", title: "Künefe", tint: "bg-purple-500" },
]

export function CarouselShelfExample() {
  return (
    <Carousel opts={{ align: "start", dragFree: true }}>
      <Text className="mb-3 text-xl font-bold">Popular</Text>
      <CarouselContent className="-ms-3">
        {picks.map((pick) => (
          <CarouselItem key={pick.title} basis={0.4} className="ps-3">
            <View className={`aspect-square rounded-2xl ${pick.tint}`} />
            <Text className="mt-2 text-sm font-semibold" numberOfLines={1}>
              {pick.title}
            </Text>
          </CarouselItem>
        ))}
      </CarouselContent>
    </Carousel>
  )
}
```

```swift
import EsuissUI
import SwiftUI

struct CarouselShelfExample: View {
  var body: some View {
    Carousel {
      Text("Popular")
        .textStyle(.xl, weight: .bold)
        .foregroundStyle(EsuissColor.foreground)
        .frame(maxWidth: .infinity, alignment: .leading)
        .padding(.bottom, 12)
      CarouselContent(spacing: 12) {
        ForEach(CarouselData.picks, id: \.title) { pick in
          CarouselItem(basis: 0.4) {
            VStack(alignment: .leading, spacing: 8) {
              RoundedRectangle(cornerRadius: Radius.xl2, style: .continuous)
                .fill(pick.tint)
                .aspectRatio(1, contentMode: .fit)
              Text(verbatim: pick.title)
                .textStyle(.sm, weight: .semibold)
                .foregroundStyle(EsuissColor.foreground)
                .lineLimit(1)
            }
          }
        }
      }
    }
  }
}

struct CarouselPick {
  let eyebrow: String
  let title: String
  let tint: Color
}

enum CarouselData {
  static let slides = [1, 2, 3, 4, 5]

  static let picks = [
    CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
    CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
    CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
    CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
  ]

  static let features = [
    "Take orders at the table.",
    "Every ticket, right on time.",
    "A full room, every night.",
  ]
}

let slides = [1, 2, 3, 4, 5]

let picks = [
  CarouselPick(eyebrow: "Today's pick", title: "Weekend breakfast", tint: Palette.amber500),
  CarouselPick(eyebrow: "New", title: "Grilled meatballs", tint: EsuissColor.destructive),
  CarouselPick(eyebrow: "Chef's special", title: "Lentil soup", tint: Palette.green500),
  CarouselPick(eyebrow: "Dessert", title: "Künefe", tint: EsuissColor.primary),
]

let features = [
  "Take orders at the table.",
  "Every ticket, right on time.",
  "A full room, every night.",
]
```

```kotlin
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.aspectRatio
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.text.style.TextOverflow
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import com.esuiss.ui.components.Carousel
import com.esuiss.ui.components.CarouselContent
import com.esuiss.ui.components.CarouselItem
import com.esuiss.ui.components.Text
import com.esuiss.ui.components.rememberCarouselState
import com.esuiss.ui.theme.Colors
import com.esuiss.ui.theme.EsuissTheme
import com.esuiss.ui.theme.Palette
import com.esuiss.ui.theme.Radius
import com.esuiss.ui.theme.Typography

class CarouselPick(val eyebrow: String, val title: String, val tint: (Colors) -> Color)

val carouselPicks = listOf(
    CarouselPick("Today's pick", "Weekend breakfast") { Palette.orange500 },
    CarouselPick("New", "Grilled meatballs") { Palette.red500 },
    CarouselPick("Chef's special", "Lentil soup") { Palette.teal500 },
    CarouselPick("Dessert", "Künefe") { Palette.purple500 },
)

val carouselSpacing = 16.dp

fun carouselPeek(width: Dp, basis: Float?, spacing: Dp = carouselSpacing): PaddingValues {
    if (basis == null) return PaddingValues(0.dp)
    val page = (width + spacing) * basis - spacing
    return PaddingValues(end = width - page)
}

@Composable
fun CarouselShelf() {
    val state = rememberCarouselState(pageCount = carouselPicks.size)
    val colors = EsuissTheme.colors
    val spacing = 12.dp
    BoxWithConstraints(Modifier.fillMaxWidth()) {
        val width = maxWidth
        Carousel(state = state, modifier = Modifier.fillMaxWidth()) {
            Text(
                "Popular",
                modifier = Modifier.padding(bottom = 12.dp),
                style = Typography.xl.copy(fontWeight = FontWeight.Bold),
            )
            CarouselContent(contentPadding = carouselPeek(width, 0.4f, spacing), pageSpacing = spacing) { page ->
                val pick = carouselPicks[page]
                CarouselItem {
                    Column(Modifier.fillMaxWidth()) {
                        Box(
                            Modifier
                                .fillMaxWidth()
                                .aspectRatio(1f)
                                .clip(RoundedCornerShape(Radius.xl2))
                                .background(pick.tint(colors)),
                        )
                        Text(
                            pick.title,
                            modifier = Modifier.padding(top = 8.dp),
                            style = Typography.sm.copy(fontWeight = FontWeight.SemiBold),
                            maxLines = 1,
                            overflow = TextOverflow.Ellipsis,
                        )
                    }
                }
            }
        }
    }
}
```

## API Reference

### Carousel

Root that holds the scroll state and options.

Also accepts the props of `React.ComponentProps<typeof CarouselPrimitive.Root>`.

### CarouselContent

Scrolling track for the slides.

Also accepts the props of `React.ComponentProps<typeof CarouselPrimitive.Content>`.

### CarouselItem

One slide.

Also accepts the props of `React.ComponentProps<typeof CarouselPrimitive.Item>`.

### CarouselPrevious

Button that scrolls to the previous slide.

Also accepts the props of `React.ComponentProps<typeof Button>`.

### CarouselNext

Button that scrolls to the next slide.

Also accepts the props of `React.ComponentProps<typeof Button>`.

### CarouselControls

Row that lays out dots and buttons below the slides.

Also accepts the props of `ViewProps`.

### CarouselDots

One pressable dot per snap point.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `variant` | `"default" \| "plain"` | `"default"` | `default` (on a control background) or `plain`. |

Also accepts the props of `ViewProps`.

### CarouselPlayButton

Toggles autoplay.

Also accepts the props of `React.ComponentProps<typeof Button>`.

## Accessibility

- Previous and next buttons have the `button` role and are labelled "Previous slide" and "Next slide", with a disabled state at the ends.
- Each dot is labelled "Go to slide N" and marks the current slide as selected.
- The play button is labelled "Pause slideshow" or "Play slideshow".

## Notes

- Arrow icons are mirrored in right-to-left layouts.
- Dot and progress animations respect the system Reduce Motion setting.
- Uses `bg-secondary`, `bg-foreground` and `bg-muted-foreground` tokens; light and dark follow the system appearance.