# Activity Heatmap (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-activity-heatmap` · version 1.0.0 · component · 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/lumen-activity-heatmap`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-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, one cell per day, in five steps of ink: months above, weekdays beside, and a grid you can read with the keyboard, where every day says its date and amount.

## 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/controls/activity-heatmap.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `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: `ActivityHeatmap`, 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-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-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 { ActivityHeatmap, type HeatmapDay } from "@/components/ui/lumen/controls/activity-heatmap";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `ActivityHeatmap` | — | The labels, the grid (activity-heatmap-grid) and the key. |

## 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/controls/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, streak, daily activity, year in days, commits graph, habit tracker
- Daily activity over a year: deploys, commits, sessions, workouts, sales days
- Showing streaks and quiet spells at a glance

### Not when
- Two categories across each other (hour by weekday): use Heatmap
- Exact trends over time: a line or bar chart reads amounts better

## Mistakes
- Dates are calendar days (YYYY-MM-DD): group your events by day in the viewer's time zone first
- Pass endDate when the latest activity isn't today and you want the year to end today

## Usage

```tsx
"use client";

import { ActivityHeatmap, type HeatmapDay } from "@/components/ui/lumen/controls/activity-heatmap";

export function DeployHistory({ days }: { days: HeatmapDay[] }) {
  return <ActivityHeatmap aria-label="Deploys" data={days} unit={{ one: "deploy", other: "deploys" }} onDayClick={(day) => console.log(day.date)} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data` | `{ date: "YYYY-MM-DD", value }[]` |  | One entry per day with activity; missing days are none. |
| `aria-label` | `string` |  | Names the grid, e.g. "Deploys". |
| `endDate` | `string` |  | The last day shown. Default: the latest day in data. |
| `weeks` | `number` | `53` | How many weeks (columns). |
| `weekStartsOn` | `0 \| 1` | `1` | Monday (1) or Sunday (0) at the top. |
| `unit` | `{ one, other }` | `{ one: "event", other: "events" }` | What a value counts, in the labels. |
| `color` | `string` |  | The busiest cells' colour. Default: ink. |
| `onDayClick` | `({ date, value }) => void` |  | A day was clicked or chosen with Enter. |
| `showLegend / showTotal / locale / labels` | `boolean / boolean / string / Partial<{ less, more, total }>` |  | The Less–More key, the total, the date language, and the words. |

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

## 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 |
|---|---|
| Left / Right | Previous / next week |
| Up / Down | Previous / next day |
| Page Up / Page Down | Four weeks back / ahead |
| Home / End | First / last week on this weekday (Ctrl: first / last day) |
| Enter | onDayClick for the day |

## Motion inventory

| Interaction | What moves |
|---|---|
| Hover or focus a day | A ring on the cell and its words above it; no other motion |

## Accessibility contract (preserve when editing)
- role=grid with seven rows (weekdays) and one tab stop
- Every day is a gridcell named in words: "4 deploys on Tuesday, 14 October 2025"
- Levels are relative (quarters of the busy days); the exact amount is always in the label

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-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 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.