# Color Palette (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-color-palette` · version 1.0.0 · component · pro (All-Access)
- category: Inputs
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-color-palette`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-color-palette
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A wheel of lit cells: hue around, paler rings inward, a neutral at the centre. Hover lifts a cell in its own light, the chosen one gets a lit rim, arrow keys walk around and in, and a pick can copy its hex. Any palette fits the wheel.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/lumen/color-palette.tsx`; shared code: `lib/beautiful-ui/lumen/color.ts`, `lib/beautiful-ui/lumen/sound.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. 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: `ColorPalette`, 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`). Never add Tailwind colour classes inside the component.

```tsx
import { ColorPalette } from "@/components/ui/lumen/color-palette";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `ColorPalette` | `color-palette` | The wheel of cells and its keyboard. |

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/color-palette.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
- color palette, colour wheel, swatch picker, label colours, tag colours, pick a colour, Lumen
- Choosing from a designed set of colours: labels, tags, calendars, avatars
- Showing a palette at a glance

### Not when
- Any colour at all, or an exact brand colour: use Color Picker

## Mistakes
- Keep text on these colours legible: check contrast with Color Picker's contrastWith
- Use names people know in your own rings; they're read aloud

## Usage

```tsx
import { ColorPalette } from "@/components/ui/lumen/color-palette";

<ColorPalette value={label.color} onValueChange={(hex) => setLabel({ ...label, color: hex })} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `rings` | `{ hex, name }[][]` | `COLOR_WHEEL` | Rings of colours, outermost first; each ring can have its own count. |
| `center` | `{ hex, name } \| null` |  | The centre cell (a neutral by default); null for none. |
| `value / defaultValue / onValueChange` | `string / (hex, color) => void` |  | The chosen hex; onValueChange also gets the colour's name. |
| `copyOnSelect` | `boolean` | `false` | Also copy the hex to the clipboard, and say so. |
| `size` | `number` | `240` | Width and height in px. |
| `label` | `string` | `"Colour palette"` | Accessible name of the palette. |
| `COLOR_WHEEL` | `{ hex, name }[][]` |  | The default wheel: 12 hues × vivid, soft and pale rings, in OKLCH, so each ring has one perceived lightness. |

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

## 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 |
|---|---|
| ← / → | Around the wheel |
| ↓ / ↑ | In towards the centre, or out |
| Enter / Space | Pick (and copy, with copyOnSelect) |
| Home | Back to the first cell |

## Motion inventory

| Interaction | What moves |
|---|---|
| Appear | Cells rise in ring by ring; still under reduced motion |
| Hover | A cell lifts and lights in its own colour |
| Pick | A white rim and a glow; one soft cue |

## Accessibility contract (preserve when editing)
- A grid of cells; each is named in words with its hex ("soft teal, #7fcdc0"), no two alike
- The chosen cell is aria-selected; one tab stop with arrow keys inside
- Copying is announced politely

## Install

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

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 conventions (https://ui.shadcn.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.