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

- id: `lumen-waffle-chart` · version 1.0.0 · component · pro (Pro)
- 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-waffle-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-waffle-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 a whole as a ten by ten grid where every square is one percent, so a share is something you can count. Squares keep their place when the data change and only the ones that change hands recolour; the list beside it gives each share and value.

## 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/waffle-chart.tsx`, `components/ui/lumen/charts/chart-frame.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: `WaffleChart`, 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-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-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 { WaffleChart } from "@/components/ui/lumen/charts/waffle-chart";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `WaffleChart` | — | The grid, list, 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/waffle-chart.tsx`, `components/ui/lumen/charts/chart-frame.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
- waffle chart, unit chart, part to whole, percentage grid, share of total, composition, mix
- A few shares of one whole (plan mix, traffic sources) where 'about a third' should be countable
- Small audiences who read squares more easily than angles

### Not when
- Many small groups (under a percent each round away): use a Bar Chart
- Change over time: use a stacked Area Chart

## Mistakes
- Keep data and config stable (outside the component, or memoised)
- Shares are rounded to whole squares (largest remainder), so a group under half a percent can show no squares; its exact share is in the list and table

## Usage

```tsx
"use client";
import { WaffleChart } from "@/components/ui/lumen/charts/waffle-chart";

const plans = [
  { plan: "starter", accounts: 412 },
  { plan: "growth", accounts: 268 },
  { plan: "scale", accounts: 96 },
];

const config = {
  starter: { label: "Starter", color: "var(--chart-1)" },
  growth: { label: "Growth", color: "var(--chart-2)" },
  scale: { label: "Scale", color: "var(--chart-3)" },
};

export function PlanMix() {
  return <WaffleChart data={plans} name="plan" value="accounts" config={config} label="Accounts by plan" />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data / name / value` | `Row[] / field / field` |  | One row per group: its name and amount. Shares come from the total. |
| `config` | `ChartConfig` |  | Colour and label per group name. Unlisted groups take the series colours in order. |
| `size` | `number` | `10` | Squares per side; 10 gives one square per percent. |
| `legend` | `"list" \| "none"` | `"list"` | Each group's share and value beside the grid (below on narrow cards). |
| `gridSize` | `number` | `260` | The grid's largest width in px. |
| `valueFormat` | `StatFormat \| (n) => string` |  | Values in the list, table and summary. |
| `active / onActiveChange / onSelect` | `string \| null / (name) => void / (name) => void` |  | The focused group, controlled; and a group was clicked or Enter pressed. |
| `motion` | `"full" \| "subtle" \| "off"` | `"full"` | Squares light in fill order; reduced motion always wins. |
| `loading / error / emptyText / label` | `boolean / string / string / string` |  | States in words with the height held, and the chart's accessible name. |

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

## Customising
- Motion: `motion="full"` (default) | `"subtle"` | `"off"`. prefers-reduced-motion is always respected.
- 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 | Focus the grid, then each list entry |
| ← / → / ↑ / ↓ | Move between groups; their squares light and the live region says the share |
| Home / End | First or last group |
| Enter / Space | Select the focused group (onSelect) |
| Escape | Clear the focus |

## Performance

- 100 plain spans (size × size), no chart library work at runtime; colour changes are CSS transitions

## Responsive

- The grid stays square up to gridSize; under 480px of card width the list moves below it

## Motion inventory

| Interaction | What moves |
|---|---|
| Draw | Squares light in fill order from the top left |
| Change | Squares keep their place; the ones that change hands fade to their new colour |
| Focus | The focused group's squares glow and the rest dim |

## Accessibility contract (preserve when editing)
- A labelled figure that says what one square is worth; the grid is one tab stop (role application) and arrow keys move between groups, said through a polite live region
- Shares are written as percents in the list, so colour is never the only cue
- A one-sentence summary and the full table for screen readers; negative values are refused in words

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-waffle-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.