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

- id: `lumen-scatter-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-scatter-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-scatter-chart
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

How two measures move together, point by point, with an optional third as bubble size: lit points by group, labelled quadrant thresholds, a tooltip naming each point, and a summary that says the relationship in words (never a cause).

## 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/scatter-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: `ScatterChart`, 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 { ScatterChart } from "@/components/ui/lumen/charts/scatter-chart";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `ScatterChart` | — | 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/scatter-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
- scatter plot, bubble chart, correlation, quadrant, two measures, accounts by size, Recharts, Lumen
- Seeing whether two measures move together, and spotting outliers

### Not when
- One measure over time: use Line
- Exact values per category: use Bar

## 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 { ScatterChart } from "@/components/ui/lumen/charts/scatter-chart";

<ScatterChart data={accounts} x="seats" y="mrr" size="nrr" name="name" group="plan" config={config} yFormat={{ style: "currency" }} thresholds={{ x: 150, y: 8000 }} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data / x / y` | `Row[] / field / field` |  | Rows and the two numeric fields. |
| `size` | `field` |  | A numeric field for bubble size. |
| `name / group` | `field / field` |  | The field that names each point, and the one that groups points (its values are config keys). |
| `config` | `ChartConfig` |  | Labels and colours per group. |
| `xFormat / yFormat / sizeFormat` | `StatFormat \| (n) => string` |  | Formats for each measure. |
| `xLabel / yLabel / sizeLabel` | `string` |  | Axis names for labels, the table and the summary. |
| `thresholds` | `{ x?, y?, xLabel?, yLabel? }` |  | Quadrant lines with labels. |
| `legend / height / motion / loading / error / emptyText / label` | `…` |  | As every Lumen chart. |

Full docs: https://beautiful-ui.dev/components/lumen-scatter-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 | Focus the chart, then the legend |
| ← / → | Move between points; the tooltip follows |

## Motion inventory

| Interaction | What moves |
|---|---|
| Draw | Points fade in |
| Hover | The point lights and glows in its group's colour |

## 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-scatter-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.