# Burn-up (Notchset): prompt.md (v2.2.0)

- id: `burn-up` · version 2.2.0 · block · pro (Pro)
- category: Charts
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add @notchset-pro/burn-up`
- npm dependencies: none
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/chart, @notchset/segmented-control
- docs: https://notchset.dev/blocks/burn-up
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Done climbs toward scope, a step line that rises the day work is added. From today a band tinted by health spans the days half and most of a forecast's runs finish, against the target. What moved the forecast can be written where it happened; read along by pointer or keys, with the forecast as it stood that day..

## Build it
- Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases).
- Packages: none beyond React.
- Files: `components/ui/notchset/blocks/burn-up.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `chart`, `segmented-control`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `BurnUp`, `BurnUpSpark`, and every exported type.
- CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) 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.
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- This item reads `--ns-bad`, `--ns-bad-ink`, `--ns-ease`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-line-soft`, `--ns-ok`, `--ns-ok-ink`, `--ns-panel`, `--ns-series`, `--ns-text-meta`, `--ns-warn`, `--ns-weight-medium`.
- Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`.
- Never add Tailwind colour classes inside the component.

```tsx
import { ChartFact, ChartHero } from "@/components/ui/notchset/chart";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/blocks/burn-up.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

### Not when

## Built from
- chart (`chart`), installed with it: reuse it, don't rebuild it
- segmented-control (`segmented-control`), installed with it: reuse it, don't rebuild it

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { ChartFact, ChartHero } from "@/components/ui/notchset/chart";
import { BurnUp } from "@/components/ui/notchset/blocks/burn-up";

/* A fictional project, 84 days in: scope grew in week 7 and jumped by 10 after the pilot; the forecast says when half and most runs finish. */
const DAYS = Array.from({ length: 85 }, (_, i) => ({ label: `Day ${i + 1}`, done: Math.round((i / 84) ** 1.15 * 48), scope: i < 49 ? 52 : i < 62 ? Math.min(58, 52 + Math.round((i - 49) * 0.5)) : 68 }));
const TICKS = [0, 28, 56, 84].map((day, k) => ({ day, label: ["Aug", "Sep", "Oct", "Nov"][k]! }));

export default function BurnUpDemo() {
  const [range, setRange] = React.useState("all");
  const [day, setDay] = React.useState<number | null>(null);
  const row = day == null ? null : DAYS[day];
  return (
    <div className="w-full max-w-[760px]">
      <BurnUp
        label="Route planner v2"
        days={DAYS}
        ahead={44}
        forecast={{ p50: 30, p85: 37 }}
        health={{ tone: "warn", word: "At risk" }}
        scopeNote={(day) => (day === 62 ? "pilot feedback" : undefined)}
        target={{ day: 31, label: "Nov 20" }}
        ticks={[...TICKS, { day: 112, label: "Dec" }]}
        ranges={[
          { value: "all", label: "Whole project", from: 0 },
          { value: "near", label: "From 4 weeks ago", from: 57 },
        ]}
        range={range}
        onRangeChange={setRange}
        onScrub={setDay}
        head={
          <>
            <ChartHero label="Likely finish" value="Thu, Nov 19" />
            <ChartFact label="Could slip to" value="Thu, Nov 26" />
            <ChartFact label={row ? `Done by ${row.label}` : "Done so far"} value={row ? `${row.done} of ${row.scope}` : "48 of 68"} instant={day != null} />
          </>
        }
      />
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `label` | `string` |  | what it is the burn-up of, for its name and its table |
| `days` | `BurnUpDay[]` |  | Required. |
| `ahead` | `number` | `0` | days after today the chart runs on, for the forecast and the target |
| `forecast` | `{ p50: number; p85: number }` |  | the days after today by which 50% and 85% of the forecast's runs finish |
| `health` | `{ tone: "ok" \| "warn" \| "bad"; word: string }` |  | the forecast's health against the target: the band takes its colour and `word` is written on it |
| `target` | `{ day: number; label: string }` |  |  |
| `plan` | `boolean` | `false` | draw the plan pace to the target and shade done ahead of or behind it (off by default, to keep the chart simple) |
| `ticks` | `{ day: number; label: string }[]` |  | the axis's periods, by day index from the first day (months, or weeks for a short range) |
| `ranges` | `BurnUpRange[]` |  |  |
| `range` | `string` |  |  |
| `onRangeChange` | `(value: string) => void` |  |  |
| `head` | `React.ReactNode` |  | the hero figure and facts above the plot (ChartHero, ChartFact); the range control sits beside them |
| `onScrub` | `(day: number \| null) => void` |  | the day the reader is on (an index into days), or null back at rest, for figures that follow along |
| `unit` | `string` | `"done"` | what done counts ("done", "closed") in the pill |
| `scopeNote` | `(day: number, added: number) => string \| undefined` |  | What explains a scope jump: called for each day scope rose by more than about three times its usual week ("Partner API added"); the chart marks the step and writes "+12 · Partner API added" above the plot. |
| `events` | `{ day: number; label: string; on?: "scope" \| "done" \| undefined }[]` |  | What moved the likely finish, written on the chart where it happened (day: an index into days), with a 1px leader down to the scope line ("scope", for work added) or the done line: "Finish 16 days later · 11 added". Given, these replace the scope-jump notes; the widest ones first, one on a narrow chart, so the default stays calm. |
| `forecastAt` | `(day: number) => string \| undefined` |  | The forecast as it stood on a day (an index into days), in words, read in the pill as you move along ("likely Nov 14"). |
| `rangeLabel` | `string` |  | The range's two days in words ("Nov 19 to Nov 26"), written on the band under its health word. |

Full docs: https://notchset.dev/blocks/burn-up

## Customising
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions).
- Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build.

## Accessibility contract (preserve when editing)

## Install

```bash
npx shadcn@latest add @notchset-pro/burn-up
```

Pro item: needs the `@notchset-pro` registry in `components.json` and `NOTCHSET_TOKEN` in `.env.local` (https://notchset.dev/account). Setup: https://notchset.dev/docs/pro. Every components.json `style` gets the same files.

The foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://notchset.dev/r/notchset-foundation.json.