# Budget Variance (Notchset): prompt.md (v1.0.0)

- id: `budget-variance` · version 1.0.0 · block · pro (Pro)
- category: Data
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/budget-variance`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui/segmented-control, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/budget-variance
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A budget-vs-actual table: a total, then departments with bullet bars (0–130% of budget, a hatched on-plan band, the budget as a mark, overspend in signal), actual, budget and variance; a department opens to its lines, a line more than 5% over can be flagged to its owner, MONTH / QUARTER / YEAR TO DATE rolls every number and glides the bars, and OVER BUDGET ONLY folds the rest.

## 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/blocks/budget-variance.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/switch-track.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `segmented-control`, `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: `BudgetVariance`, 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-glide`, `--notchset-ease-key-down`, `--notchset-ease-key-up`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-grow-to`, `--notchset-key-down`, `--notchset-key-up`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scan-to`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`, `--notchset-travel`). Never add Tailwind colour classes inside the component.

```tsx
import { BudgetVariance, type BudgetDepartment, type BudgetLine } from "@/components/ui/notchset/blocks/budget-variance";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `BudgetVariance` | `budget-variance` | Header controls, total, departments with lines, flags 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/blocks/budget-variance.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
- budget vs actual, variance report, spend by department, FP&A, cost control, finance dashboard, overspend, Notchset
- Monthly or quarterly budget reviews by team
- Finding which line items drive an overspend

### Not when
- A ledger of transactions: use a data table
- Forecasting cash: use Cash Runway

## Mistakes
- Pass amounts for every period id, or the period shows zeros
- Notify owners on the server; the block only reports the flag

## Usage

```tsx
import { BudgetVariance, type BudgetDepartment, type BudgetLine } from "@/components/ui/notchset/blocks/budget-variance";

export function Spend({ departments }: { departments: BudgetDepartment[] }) {
  return (
    <BudgetVariance
      title="Budget vs actual"
      periods={[{ id: "month", label: "MONTH", caption: "SEPTEMBER 2026" }]}
      departments={departments}
      onFlag={(line: BudgetLine, department: BudgetDepartment, flagged: boolean) =>
        fetch("/api/flags", { method: "POST", body: JSON.stringify({ line: line.id, owner: department.owner, flagged }) })
      }
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `departments` | `{ id, name, owner, initials, lines: { id, name, amounts }[] }[]` |  | amounts maps each period id to [actual, budget] in currency units. |
| `periods` | `{ id, label, caption }[]` |  | The period control (MONTH / QUARTER / YEAR TO DATE) and the caption above the title. |
| `title / currency` | `string` |  | The heading and the currency after the caption (USD). |
| `defaultFlagged / onFlag` | `string[] / (line, department, flagged) => void` |  | Lines flagged at the start, and notifying a line's owner. |

Full docs: https://beautiful-ui.dev/components/budget-variance

## 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 |
|---|---|
| Tab then Enter | Open a department, flag a line |
| ← → | Change the period |
| Space | Toggle OVER BUDGET ONLY |

## Performance

- Plain rows and CSS transitions; nothing runs while idle.

## Responsive

- Under 700px (container width) the table keeps 660px and scrolls sideways.

## Motion inventory

| Interaction | What moves |
|---|---|
| Period | Numbers roll and bars glide to their new length (620ms, 40ms apart per row) |
| Open a department | Rows unroll (380ms) and lines cascade in 45ms apart |
| OVER BUDGET ONLY | On-plan departments fold away (360ms) |

## Accessibility contract (preserve when editing)
- Each department's chevron is a button with aria-expanded; the row itself also toggles for pointer users
- Flags are toggle buttons (aria-pressed) named with the line and its owner
- OVER BUDGET ONLY is a switch; folded departments leave the tab order; the flag count is a polite live region

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/budget-variance
```

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.