# Donut Chart (Lumen Halo): prompt.md (v1.0.0)

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

Parts of one whole: the total in the middle follows the slice you point at or focus in the legend, which steps out with a glow; small slices fold into Other; the legend shows each value and share. Negative values are refused in words and missing values are named, not drawn as zero.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `recharts@^3`.
- Files: `components/ui/lumen/charts/donut-chart.tsx`, `components/ui/lumen/charts/cartesian.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-chart`, `lumen-stat`, `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: `DonutChart`, 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-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { DonutChart } from "@/components/ui/lumen/charts/donut-chart";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `DonutChart` | — | The plot, legend, readout, states, summary and table. |

## 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/charts/donut-chart.tsx`, `components/ui/lumen/charts/cartesian.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
- donut chart, pie chart, share, mix, part of whole, composition, Recharts, Lumen
- How one whole splits into a few parts

### Not when
- More than ~6 parts or values to compare exactly: use Bar
- Change over time: use Area (percent)

## Mistakes
- Keep data and config stable (outside the component, or memoised)
- Say what zero and missing mean for your data; the chart keeps them apart

## Usage

```tsx
import { DonutChart } from "@/components/ui/lumen/charts/donut-chart";

<DonutChart data={byProduct} name="product" value="revenue" config={config} valueFormat={{ style: "currency" }} maxSlices={5} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data / name / value` | `Row[] / field / field` |  | Rows, the category field and the value field. |
| `config` | `ChartConfig` |  | Labels and colours per category value; others take the series colours (Lumen's, or your --chart-N under lumen-inherit) in order, stably. |
| `valueFormat` | `StatFormat \| (n) => string` |  | Numbers in the centre, legend and table. |
| `maxSlices / otherLabel` | `number / string` |  | Show at most this many slices; the rest become Other (default 6). |
| `totalLabel` | `string` |  | The words under the centre total (default Total). |
| `thickness / height` | `number / number` |  | Ring thickness as a share of the radius (0.2–0.6), and plot height. |
| `legend` | `"values" \| "plain" \| "none"` |  | Values and shares in the legend, names only, or none. |
| `onSelect` | `(category) => void` |  | A slice or legend entry was chosen (not Other). |
| `motion / loading / error / emptyText / label` | `…` |  | As every Lumen chart. |

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

## 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 |
|---|---|
| Tab | Move through the legend; the focused product lights its slice and the centre |
| Enter | Choose the focused product (onSelect) |

## Motion inventory

| Interaction | What moves |
|---|---|
| Draw | The ring sweeps in |
| Point or focus | The slice steps out and glows; the rest dim; the centre shows it |

## Accessibility contract (preserve when editing)
- A labelled figure with a one-sentence summary and the full data table for screen readers
- States (loading, empty, error) are said in words

## Install

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

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

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.