# Calendar (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-calendar` · version 1.0.0 · component · pro (All-Access)
- category: Inputs
- build: Base UI (this item also ships a Radix build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-calendar`
- npm dependencies: react-day-picker@^10
- registry dependencies: utils, @beautiful-ui/lumen-button, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-calendar
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Days are cells on the panel: chosen days light up with a soft glow, a range is a band of dimmer lit cells between two bright ends, and today carries a small lit segment under its number. Single, multiple and range, with one month or two. shadcn's Calendar, cut from Lumen glass.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `react-day-picker@^10`.
- Files: `components/ui/lumen/calendar.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-button`, `lumen-foundation`.
- Builds: separate Base UI and Radix files. 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: `Calendar`, `CalendarDayButton`, 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 { Calendar } from "@/components/ui/lumen/calendar";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Calendar` | `calendar` | The month grid. |
| `CalendarDayButton` | — | One day cell (override it through components). |

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 `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/calendar.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
- calendar, date picker, date range, pick a date, pick dates, booking calendar, shadcn calendar, Lumen
- Picking a day, several days or a range where seeing the month helps
- Inside a Date Picker or Date Compare popover

### Not when
- A birth date or a date far away: type it in an Input
- Reporting periods: use Date Compare, which adds presets and comparison

## Mistakes
- Disable the days that make no sense (future dates for reports)
- Use two months for ranges on desktop, one on phones

## Usage

```tsx
"use client";

import * as React from "react";
import { Calendar } from "@/components/ui/lumen/calendar";

const [range, setRange] = React.useState<DateRange | undefined>();

<Calendar mode="range" numberOfMonths={2} selected={range} onSelect={setRange} disabled={{ after: new Date() }} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `mode` | `"single" \| "multiple" \| "range"` |  | react-day-picker's selection mode. |
| `numberOfMonths` | `number` | `1` | Two for ranges on desktop. |
| `captionLayout` | `"label" \| "dropdown" \| "dropdown-months" \| "dropdown-years"` | `"label"` | Month and year as a label or as dropdowns. |
| `disabled` | `Matcher \| Matcher[]` |  | Days that can't be picked (past, future, weekends). |
| `timeZone` | `string` |  | Show days in this zone (react-day-picker's TZDate). |
| `buttonVariant` | `Button variant` | `"ghost"` | The month arrows. |

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

## 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 |
|---|---|
| ← → ↑ ↓ | Move by day or week |
| PageUp / PageDown | Previous or next month |
| Home / End | Start or end of the week |
| Enter / Space | Pick |

## Motion inventory

| Interaction | What moves |
|---|---|
| Pick | The cell lights with its glow; a subtle tap |

## Accessibility contract (preserve when editing)
- A grid with arrow-key navigation (react-day-picker)
- Days announce their full date and state
- Chosen days are shown by fill and weight, not colour alone

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-calendar
```

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)
- react-day-picker (https://daypicker.dev)

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.