# Activity Heatmap (Notchset): prompt.md (v1.0.0)

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

A year of days where size carries the value, weeks from Monday, a signal ring for a milestone, a diagonal ripple when the data changes, and a crop-mark reticle that reads each day out.

## 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/activity-heatmap.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: `ActivityHeatmap`, 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 { ActivityHeatmap, type HeatDay } from "@/components/ui/notchset/activity-heatmap";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `ActivityHeatmap` | `activity-heatmap` | The grid. |

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/activity-heatmap.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
- activity heatmap, contribution graph, calendar heatmap, daily activity, year view, Notchset
- Daily activity across a year

### Not when
- Exact daily values: use Bar Chart or a table

## Mistakes
- Size carries value: keep steps meaningful for your scale

## Usage

```tsx
import { ActivityHeatmap, type HeatDay } from "@/components/ui/notchset/activity-heatmap";

const DAY = 864e5;
const start = Date.UTC(2026, 0, 1);
// One cell per day; null for days with no data.
const days: HeatDay[] = Array.from({ length: 180 }, (_, i) => ({ date: new Date(start + i * DAY), value: i % 7 === 6 ? null : Math.round(20 + 80 * Math.abs(Math.sin(i / 9))) }));

export function RunHeatmap() {
  return <ActivityHeatmap days={days} describe={(d) => `${d.value ?? 0} RUNS`} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `days` | `{ date, value \| null }[]` |  | A year, in order; null for days to come. |
| `steps` | `[n, n, n]` |  | Where marks step up. |
| `milestone` | `{ date, label }` |  | A ringed day. |
| `describe` | `(day, busiest) => ReactNode` |  | The footer. |

Full docs: https://beautiful-ui.dev/components/activity-heatmap

## 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; the busiest day is always in text |

## Performance

- ~365 circles; CSS transitions.

## Responsive

- Scales with its container (viewBox).

## Motion inventory

| Interaction | What moves |
|---|---|
| Data | Marks ripple diagonally (380ms pop, by column and row) |
| Hover | The reticle glides to the day (140ms) |

## Accessibility contract (preserve when editing)
- An image labelled by you; the footer reads the hovered or busiest day aloud

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/activity-heatmap
```

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.