# Waffle Chart (Notchset): prompt.md (v1.0.0)

- id: `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/waffle-chart`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/waffle-chart
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

One hundred squares, each a percent, filled column by column in ink tones and a hatch; new shares ripple across the grid, and hovering a legend row isolates its squares.

## 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/notchset/waffle-chart.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/calendar.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-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 adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet 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 `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

```tsx
import { WaffleChart } from "@/components/ui/notchset/waffle-chart";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `WaffleChart` | `waffle-chart` | Grid and legend. |

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 `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/waffle-chart.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, square pie, percentage grid, share of spend, composition, Notchset
- Shares of a whole people should count

### Not when
- More than five parts: use Donut Chart

## Mistakes
- Shares must total 100

## Usage

```tsx
import { WaffleChart } from "@/components/ui/notchset/waffle-chart";

// Whole percentages that add up to 100.
const byModel = [
  { label: "Atlas 3 Flash", share: 58 },
  { label: "Atlas 3", share: 22 },
  { label: "Atlas 3 Pro", share: 11 },
  { label: "Atlas 2", share: 6 },
  { label: "Embeddings", share: 3 },
];

export function SpendByModel() {
  return <WaffleChart data={byModel} total={528} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data` | `{ label, share }[]` |  | Whole percentages totalling 100. |
| `total` | `number` |  | For each row's amount. |
| `format` | `(v) => string` |  | Amounts. |

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

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- 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 |
|---|---|
| — | Pointer hover; values are in text nearby |

## Performance

- 100 rects; CSS.

## Responsive

- Grid fixed; legend wraps under on narrow screens.

## Motion inventory

| Interaction | What moves |
|---|---|
| Data | Squares change in order, 7ms apart |

## Accessibility contract (preserve when editing)
- Labelled with each share; the legend is text

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/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 (https://ui.shadcn.com)

The notchset 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/notchset-foundation.json.