# Carousel (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-carousel` · version 1.0.0 · component · pro (All-Access)
- category: Media & effects
- build: Base UI (this item also ships a Radix build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-carousel`
- npm dependencies: embla-carousel-react@^8
- registry dependencies: utils, @beautiful-ui/lumen-button, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-carousel
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Slides that glide on Embla: the ones peeking at the edges dim so the slide in view glows, the arrows sit as a pager beside the position, a row of cells with the current one stretched into a lit filament. shadcn's Carousel, cut from Lumen glass.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `embla-carousel-react@^8`.
- Files: `components/ui/lumen/carousel.tsx`; shared code: `lib/beautiful-ui/lumen/sound.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-button`, `lumen-foundation`.
- Builds: separate Base UI and Radix files. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `Carousel`, `CarouselContent`, `CarouselItem`, `CarouselPrevious / CarouselNext`, `CarouselDots`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

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

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Carousel` | `carousel` | Root: Embla, keyboard and context. |
| `CarouselContent` | `carousel-content` | The viewport and track. |
| `CarouselItem` | `carousel-item` | One slide. |
| `CarouselPrevious / CarouselNext` | `carousel-previous` | Glass arrows. |
| `CarouselDots` | `carousel-dots` | Beautiful UI: the position as cells. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/carousel.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- carousel, slider of cards, image carousel, gallery, what's new, testimonials, onboarding slides, shadcn carousel, Lumen
- A handful of peers people browse one at a time: highlights, screenshots, testimonials
- Phones, where a swipeable row beats a wrapped grid

### Not when
- Content everyone must see: most people never reach slide three
- Comparing items side by side: use a grid or Table

## Mistakes
- Right to left: pass opts={{ direction: "rtl" }} (and dir="rtl" on an ancestor); arrow keys follow it
- Size slides with basis classes on CarouselItem (basis-4/5 shows the neighbours peeking)
- Give a vertical carousel a height on CarouselContent
- Don't autoplay without a pause

## Usage

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

<Carousel opts={{ align: "center" }}>
  <CarouselContent>
    <CarouselItem className="basis-4/5">…</CarouselItem>
    <CarouselItem className="basis-4/5">…</CarouselItem>
  </CarouselContent>
  <CarouselPrevious />
  <CarouselNext />
  <CarouselDots />
</Carousel>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `opts` | `EmblaOptionsType` |  | Embla options (loop, align, slidesToScroll…). |
| `plugins` | `EmblaPluginType[]` |  | Embla plugins, e.g. Autoplay. |
| `orientation` | `"horizontal" \| "vertical"` | `"horizontal"` | Axis. |
| `setApi` | `(api: CarouselApi) => void` |  | Receive Embla's API. |

Full docs: https://beautiful-ui.dev/components/lumen-carousel

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| ArrowLeft / ArrowRight | Previous / next slide |
| Tab | Arrows, then the position cells |

## Motion inventory

| Interaction | What moves |
|---|---|
| Slide | Embla's glide; slides leaving view dim and ease back a touch |
| Position | The current cell stretches into a lit filament |

## Accessibility contract (preserve when editing)
- A region with aria-roledescription="carousel"; each slide is a group with aria-roledescription="slide"
- Arrows are labelled buttons, disabled at the ends
- Each position cell is a button naming its slide; the current one has aria-current

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-carousel
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)
- Embla Carousel (https://www.embla-carousel.com)

The lumen foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/lumen-foundation.json.