# Timeline (Notchset): prompt.md (v2.1.0)

- id: `timeline` · version 2.1.0 · block · pro (Pro)
- category: Application UI
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add @notchset-pro/timeline`
- npm dependencies: lucide-react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/blocks/timeline
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

When work runs, as bars on days grouped by milestone, the list on the left keeping each task's glyph, title and owner beside its bar; a group's due day is a diamond and today a thin line in the Signature. Drag a bar or focus it and press the arrows to move its dates; a refused move springs back..

## 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: `lucide-react@^1`.
- Files: `components/ui/notchset/blocks/timeline.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `Timeline`, 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-font-mono`, `--ns-gutter`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-line-soft`, `--ns-panel`, `--ns-signal`, `--ns-text-meta`, `--ns-text-small`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-well`.
- 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 { StatusGlyph } from "@/components/ui/notchset/status-glyph";
```

## Parts
- A single export that takes props.

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

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { StatusGlyph } from "@/components/ui/notchset/status-glyph";
import { Timeline } from "@/components/ui/notchset/blocks/timeline";

const START = [
  { id: "RP-49", group: "beta", title: "Recalculate ETA when a job runs long", start: -6, end: -1, started: true, late: true },
  { id: "RP-57", group: "beta", title: "Undo for route edits", start: -3, end: 0, started: true },
  { id: "RP-60", group: "launch", title: "Explain why a stop moved", start: 4, end: 7 },
];

export default function TimelineDemo() {
  const [rows, setRows] = React.useState(START);
  const [open, setOpen] = React.useState<string | null>(null);
  return (
    <div className="flex w-full flex-col gap-2">
      <Timeline
        label="Route planner v2: open work by milestone"
        groups={[
          { key: "beta", label: "Planner beta", due: { day: 10, label: "Oct 30" } },
          { key: "launch", label: "Public launch" },
        ]}
        rows={rows.map((r) => ({ ...r, glyph: <StatusGlyph status={r.started ? "doing" : "todo"} label={r.title} /> }))}
        from={-10}
        to={20}
        ticks={[-8, -1, 6, 13, 20].map((day) => ({ day, label: `Day ${day}` }))}
        dayName={(d) => (d === 0 ? "today" : d < 0 ? `${-d} days ago` : `in ${d} days`)}
        onOpen={setOpen}
        onMove={(id, by) => setRows((rs) => rs.map((r) => (r.id === id ? { ...r, end: r.end + by, start: r.started ? r.start : r.start + by } : r)))}
      />
      {open && <p className="m-0 px-[var(--ns-gutter)] text-[length:var(--ns-text-small)] text-[var(--ns-ink-3)]">Opened {open}</p>}
    </div>
  );
}
```

This example also uses `status-glyph` (https://notchset.dev/components/status-glyph). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add @notchset-pro/timeline @notchset/status-glyph`. The `@notchset-pro` items are Pro: they need the registries in components.json and the key (Setup).

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `groups` | `TimelineGroup[]` |  | Required. |
| `rows` | `TimelineRow[]` |  | Required. |
| `from` | `number` |  | Required. |
| `to` | `number` |  | Required. |
| `ticks` | `{ day: number; label: string }[]` |  | the axis's labels (each week's Monday), by day |
| `dayName` | `(day: number) => string` |  | what a day is called, for a bar's words ("Mon, Oct 19") |
| `onMove` | `(id: string, by: number) => boolean \| void` |  | Required. |
| `onResize` | `(id: string, edge: "start" \| "end", by: number) => boolean \| void` |  | one end moved (the start or the end), by days; refuse with false |
| `onOpen` | `(id: string) => void` |  | Required. |
| `links` | `{ from: string; to: string }[]` | `[]` | what waits on what: drawn for the bar in focus |
| `dayWidth` | `number` | `26` | pixels per day: 26 for weeks, about 10 for months |
| `today` | `number` | `0` | change it to scroll back to today |
| `label` | `string` |  | Required. |

Full docs: https://notchset.dev/blocks/timeline

## 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/timeline
```

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.