# MRR Waterfall (Lumen Halo): prompt.md (v1.0.0)

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

A period's MRR bridge as floating steps: start, new, expansion, contraction, churn, end. Gains rise in the good hue and losses fall in the bad one, with connectors carrying each level on. The end is worked out from the steps, and a recorded end that disagrees shows as its own Unexplained step rather than being hidden.

## 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/mrr-waterfall.tsx`; shared code: `lib/beautiful-ui/lumen/waterfall-model.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-chart`, `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: `MrrWaterfall`, `MrrWaterfallPlot`, `MrrWaterfallHeadline`, 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 { MrrWaterfallCard } from "@/components/ui/lumen/mrr-waterfall";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `MrrWaterfall` | — | Data and the period. |
| `MrrWaterfallPlot` | `mrr-waterfall-plot` | The steps, edges and connectors. |
| `MrrWaterfallHeadline` | — | Net change and the biggest gain and loss. |

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/mrr-waterfall.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
- MRR waterfall, revenue bridge, MRR movements, net new MRR, expansion and churn, SaaS metrics, Lumen
- How MRR got from the start of a period to the end
- Board and investor updates on revenue movement

### Not when
- MRR over many periods: use Trend or Area
- Share of MRR by plan: use Orbit

## Mistakes
- Pass the movements for the same period as start; the end is worked out from them
- If you pass end and it disagrees, the Unexplained step is the signal: find the missing movement

## Usage

```tsx
import { MrrWaterfallCard } from "@/components/ui/lumen/mrr-waterfall";

<MrrWaterfallCard periods={[{ id: "sep", label: "September", start: 904200, new: 27800, expansion: 19400, contraction: 12300, churn: 15500 }]} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `periods` | `{ id, label, start, new, expansion, contraction, churn, end? }[]` | `three months of Lumen's MRR` | One per period, oldest first. Losses can be positive or negative; they fall either way. end, when given, is reconciled against the steps. |
| `period / defaultPeriod / onPeriodChange` | `string` |  | The shown period (default: the latest). |
| `labels` | `Partial<Record<step, string>>` |  | Step names, for i18n. |
| `formatValue / locale / currency` | `(v) => string / string / string` | `compact USD` | How money reads. |
| `title / eyebrow / motion` | `…` |  | Names and motion. |
| `Parts` | `MrrWaterfallPlot · Periods · Headline · Table · Card` |  | Arrange them inside <MrrWaterfall>, or use MrrWaterfallCard; useMrrWaterfall() reads the state. |

Full docs: https://beautiful-ui.dev/components/lumen-mrr-waterfall

## 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 |
|---|---|
| ← / → | Walk the steps |
| Escape | Clear |

## Motion inventory

| Interaction | What moves |
|---|---|
| Enter | Each step is a stack of lit cells that drop into place, step after step |
| Point | The step or cell lights; the rest dim |

## Accessibility contract (preserve when editing)
- The plot is one tab stop: arrows walk the steps, each said with its change and levels
- The axis note says when the axis doesn't start at zero
- Every step is in the data table

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-mrr-waterfall
```

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 chart 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.