# Notifications (Notchset): prompt.md (v1.0.0)

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

A bell and a panel for what needs a decision: unread count in signal, NEEDS YOU / MENTIONS / ALL, items grouped by time with actions inline (approve, re-run, raise a cap, reply), results that fold the row away, and a pause switch.

## 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/notchset/blocks/notifications.tsx`; shared code: `lib/beautiful-ui/notchset/blocks.tsx`, `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `segmented-control`, `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: `Notifications`, 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 { Notifications, type Notice } from "@/components/ui/notchset/blocks/notifications";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Notifications` | `notifications` | The bell and its panel. |

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/notifications.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
- notifications, notification center, inbox dropdown, bell menu, approvals, activity panel, Notchset
- An app bar's bell where people approve, retry or reply without leaving the page

### Not when
- A full inbox with search and history: a page fits better
- Passing confirmations: use a toast

## Mistakes
- Remove a notice in onDismiss, not in onAction: the row needs to show its result first
- Set unread in your data and clear it in onRead: the count comes from your notices

## Usage

```tsx
"use client";

import * as React from "react";
import { Notifications, type Notice } from "@/components/ui/notchset/blocks/notifications";

export function Bell() {
  const [notices, setNotices] = React.useState<Notice[]>([
    { id: "1", kind: "approval", title: "Planner wants to send an email", detail: "SEND_EMAIL · RUN 8F3A1", time: "2 MIN", group: "NOW", needsYou: true, unread: true, actions: [{ label: "APPROVE" }] },
  ]);
  return (
    <Notifications
      notices={notices}
      onAction={async () => "APPROVED · EMAIL SENT"}
      onRead={(ids) => setNotices((list) => list.map((n) => (ids.includes(n.id) ? { ...n, unread: false } : n)))}
      onDismiss={(id) => setNotices((list) => list.filter((n) => n.id !== id))}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `notices` | `{ id, kind, title, detail, time, group, needsYou?, mention?, unread?, avatar?, actions? }[]` |  | kind is approval, failure, budget, info or mention (it picks the tile); actions with reply open an inline input. |
| `onAction` | `(notice, action, replyText?) => string \| Promise<string>` |  | Return the result line; a promise shows WORKING until it settles (a rejection puts the actions back). |
| `onRead / onDismiss` | `(ids) => void / (id) => void` |  | Mark read; drop a row once it has folded away. |
| `paused / onPausedChange / pauseLabel / pausedLabel` | `boolean / string` |  | The footer's pause switch (shown when onPausedChange is set). |
| `emptyTitle / emptyBody` | `string / ReactNode` |  | What an empty filter says. |
| `open / defaultOpen / onOpenChange` | `boolean` |  | The panel. |

Full docs: https://beautiful-ui.dev/components/notifications

## 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 |
|---|---|
| Enter / Space | Open, act, toggle pause |
| ← → | Filter (NEEDS YOU, MENTIONS, ALL) |
| Enter / Esc (reply) | Send / cancel (ignored while composing with an IME) |
| Esc | Close the panel |

## Performance

- Plain DOM; timers are per action and cleared on unmount.

## Responsive

- The panel is 420px and never wider than the viewport minus 24px.

## Motion inventory

| Interaction | What moves |
|---|---|
| Bell | Swings 14° and back (380ms) when toggled; inverts while open |
| Panel | Opens with a clip from the top right (380ms), closes faster (240ms) |
| Result | Shows for 1.5s, then the row folds away (320ms) and the counts roll |

## Accessibility contract (preserve when editing)
- The bell names its unread count and controls the panel (aria-expanded); the panel is a labelled dialog that takes focus on open and returns it on close
- Items are a list; WORKING and each result are announced; info items' DONE has a full name
- Esc or a press outside closes the panel; Esc in a reply cancels it

## Install

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

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.
