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

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

A file as a glass chip with its type in a recessed cell: a filament fills along the lower edge as it uploads, light sweeps the name while it works, an error lights a red lamp, and it chimes once when it lands. shadcn's Attachment, 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: `@base-ui/react@^1`, `class-variance-authority@^0.7` (Base UI build); `class-variance-authority@^0.7`, `radix-ui@^1` (Radix build).
- Files: `components/ui/lumen/attachment.tsx`; shared code: `lib/beautiful-ui/lumen/sound.ts`.
- 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: `Attachment`, `AttachmentMedia`, `AttachmentContent / AttachmentTitle / AttachmentDescription`, `AttachmentActions / AttachmentAction`, `AttachmentTrigger`, `AttachmentGroup`, 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-text`, `--lumen-bad`, `--lumen-bad-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-attachment-progress`, `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { Attachment, AttachmentAction, AttachmentActions, AttachmentContent, AttachmentDescription, AttachmentMedia, AttachmentTitle } from "@/components/ui/lumen/attachment";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Attachment` | `attachment` | The chip, with its state and filament. |
| `AttachmentMedia` | `attachment-media` | The type cell or image. |
| `AttachmentContent / AttachmentTitle / AttachmentDescription` | `attachment-content` | Name and details. |
| `AttachmentActions / AttachmentAction` | `attachment-actions` | Remove, retry, cancel. |
| `AttachmentTrigger` | `attachment-trigger` | Makes the whole chip clickable. |
| `AttachmentGroup` | `attachment-group` | A row that scrolls and snaps. |

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/attachment.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
- attachment, file chip, uploaded file, upload progress, file list, chat attachment, image thumbnail, shadcn attachment, Lumen
- Files attached to a message, ticket or form, with their upload state
- A row of uploads under a Dropzone

### Not when
- Browsing many files: use Table or a grid
- Picking files: that's Dropzone (Attachment shows what was picked)

## Mistakes
- Long names truncate: keep the extension in the description too
- Keep a Retry on errors, not only Remove
- Wrap many chips in AttachmentGroup so they scroll instead of wrapping

## Usage

```tsx
import { Attachment, AttachmentAction, AttachmentActions, AttachmentContent, AttachmentDescription, AttachmentMedia, AttachmentTitle } from "@/components/ui/lumen/attachment";

<Attachment state="uploading" progress={0.42}>
  <AttachmentMedia><FileIcon /></AttachmentMedia>
  <AttachmentContent>
    <AttachmentTitle>q3-board-deck.pdf</AttachmentTitle>
    <AttachmentDescription>1.2 of 2.8 MB</AttachmentDescription>
  </AttachmentContent>
  <AttachmentActions>
    <AttachmentAction aria-label="Cancel upload"><XIcon /></AttachmentAction>
  </AttachmentActions>
</Attachment>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `state` | `"idle" \| "uploading" \| "processing" \| "error" \| "done"` | `"done"` | Where the file is. |
| `progress` | `number` |  | Beautiful UI: 0–1 upload progress for the filament; leave it out for a scanning beam. |
| `size` | `"default" \| "sm" \| "xs"` | `"default"` | Chip size. |
| `orientation` | `"horizontal" \| "vertical"` | `"horizontal"` | A chip, or a tile with the preview on top. |
| `variant (AttachmentMedia)` | `"icon" \| "image"` | `"icon"` | A type glyph or an image preview. |

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

## 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 |
|---|---|
| Tab | The trigger, then each action |
| Enter / Space | Open, or run the focused action |

## Motion inventory

| Interaction | What moves |
|---|---|
| Upload | The filament fills to progress; light sweeps the name |
| Processing | The filament becomes a scanning beam |
| Done / error | The type cell lights (accent or red); one cue |

## Accessibility contract (preserve when editing)
- Say the state in the description (“Uploading · 42%”, “Failed: too large”); the filament is decoration
- Label icon-only actions (Remove, Retry, Cancel)
- AttachmentTrigger makes the whole chip open the file

## Install

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

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.