# Invoice Studio (Notchset): prompt.md (v1.0.0)

- id: `invoice-studio` · version 1.0.0 · block · pro (Pro)
- category: Application UI
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/invoice-studio`
- npm dependencies: class-variance-authority@^0.7
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/invoice-studio
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

An invoice you write in place: status and dates, FROM and BILL TO, editable line items (numbers only for quantity and rate) whose amounts and totals roll as you type, metered lines imported from usage, VAT, SAVE DRAFT, then SEND, MARK AS PAID and REOPEN; sending locks the lines and an empty invoice can't be sent.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `class-variance-authority@^0.7`.
- Files: `components/ui/notchset/blocks/invoice-studio.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/button-variants.ts`.
- 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: `InvoiceStudio`, 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-glide`, `--notchset-ease-key-down`, `--notchset-ease-key-up`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-grow-to`, `--notchset-key-down`, `--notchset-key-up`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scan-to`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`, `--notchset-travel`). Never add Tailwind colour classes inside the component.

```tsx
import { InvoiceStudio, type InvoiceStudioProps } from "@/components/ui/notchset/blocks/invoice-studio";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `InvoiceStudio` | `invoice-studio` | Header, parties, lines, totals and actions. |

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/blocks/invoice-studio.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
- invoice, invoice editor, billing, line items, send invoice, mark as paid, usage billing, vat, Notchset
- Agencies and products that bill customers by invoice
- Turning metered usage into invoice lines

### Not when
- Card checkout: use Checkout
- A read-only receipt: render a static table

## Mistakes
- Recalculate totals on the server before sending; the block's totals are for the person writing it
- Lock edits server-side after sending, not only in the UI

## Usage

```tsx
import { InvoiceStudio, type InvoiceStudioProps } from "@/components/ui/notchset/blocks/invoice-studio";

export function Invoice({ invoice }: { invoice: Omit<InvoiceStudioProps, "onSend" | "onSaveDraft"> & { id: string } }) {
  return (
    <InvoiceStudio
      {...invoice}
      onSaveDraft={(draft) => fetch(`/api/invoices/${invoice.id}`, { method: "PUT", body: JSON.stringify(draft) })}
      onSend={(draft) => fetch(`/api/invoices/${invoice.id}/send`, { method: "POST", body: JSON.stringify(draft) }).then((r) => {
        if (!r.ok) throw new Error("send failed");
      })}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `number / issued / due` | `string` |  | Shown in the header. |
| `from / billTo` | `{ name, address } / { name, address, email }` |  | The parties; billTo.email is named when the invoice is sent. |
| `lines` | `{ id, description, quantity, rate, metered? }[]` |  | Quantity and rate are strings so typing stays exact; only numbers are accepted. |
| `taxRates` | `number[]` |  | VAT choices as fractions (default 0.19, 0.07, 0). |
| `onSend / onMarkPaid / onReopen / onSaveDraft` | `(invoice) => Promise` |  | Each gets { lines, taxRate, subtotal, tax, total }; resolve to move on, reject to stay put. |
| `onImportUsage / importLabel` | `() => Promise<lines> / string` |  | Adds the import button; returned lines are marked METERED. |

Full docs: https://beautiful-ui.dev/components/invoice-studio

## 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 |
|---|---|
| Tab | Through the cells of each line |
| Enter / Space | Add a line, import, save, send |

## Performance

- Totals are simple sums on each keystroke; nothing runs while idle.

## Responsive

- Under 600px (container width) each line puts its description on its own row above quantity, rate and amount.

## Motion inventory

| Interaction | What moves |
|---|---|
| Typing | Line amounts and totals roll, 60ms apart |
| New lines | Rise in as they are added or imported |
| Send | The scanner, then the status tag inverts |

## Accessibility contract (preserve when editing)
- Line items are a table; every input is labelled with its line and column
- The status tag and the status line are announced as they change
- Remove and VAT buttons are aria-disabled once the invoice is sent

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/invoice-studio
```

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.