# Empty States (Notchset): prompt.md (v1.0.0)

- id: `empty-states` · 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/empty-states`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/empty-states
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Five empty states that say why a screen is empty and offer the one action that fixes it, each with a diagram drawn from lines and nodes: no results (remove filters one by one), offline (retry with a countdown), caught up, not found (closest matches) and first run (steps that enable in turn).

## 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/empty-states.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.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: `CaughtUpState`, `EmptyState`, `FirstRunState`, `NoResultsState`, `NotFoundState`, `OfflineState`, 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 { OfflineState } from "@/components/ui/notchset/blocks/empty-states";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `EmptyState` | `empty-state` | The frame: diagram, title, line, actions. |
| `NoResultsState` | — | Filters to remove and the matches. |
| `OfflineState` | — | Retry and the countdown. |
| `CaughtUpState` | — | Earlier history and a pause. |
| `NotFoundState` | — | The closest matches. |
| `FirstRunState` | — | Steps that enable in turn. |

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/empty-states.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
- empty state, no results, offline state, not found, 404, first run, onboarding empty, zero state, Notchset
- Any list, search or page that can be empty, offline or not found
- The first visit before there is any data

### Not when
- Loading: use Skeleton
- An error that needs a stack trace: show the error

## Mistakes
- Say which filter is the problem in body: the state is only useful when it names the fix
- Keep the countdown honest: retry when it reaches zero

## Usage

```tsx
"use client";

import * as React from "react";
import { OfflineState } from "@/components/ui/notchset/blocks/empty-states";

export function Offline() {
  const [status, setStatus] = React.useState<"offline" | "connecting" | "online">("offline");
  return (
    <OfflineState
      status={status}
      retryIn={12}
      onRetry={() => {
        setStatus("connecting");
        fetch("/api/ping").then(
          (res) => setStatus(res.ok ? "online" : "offline"),
          () => setStatus("offline"),
        );
      }}
      body="3 changes are saved on this device and will sync when you reconnect."
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `EmptyState` | `{ diagram?, title, children?, actions? }` |  | The frame, for a state of your own. |
| `NoResultsState` | `{ query?, filters, onRemoveFilter, onClearFilters, total, count, matches, title?, body? }` |  | Filter chips come off one by one; the bars fill and SHOW n RUNS lists the matches. |
| `OfflineState` | `{ status, onRetry, retryIn?, service?, title?, body? }` |  | status is offline, connecting or online; the countdown rolls. |
| `CaughtUpState` | `{ earlier, paused?, onPausedChange?, title?, body? }` |  | Twelve dots pop in; VIEW EARLIER expands recent history. |
| `NotFoundState` | `{ label, suggestions, onPick, note?, title, body? }` |  | The closest matches as buttons. |
| `FirstRunState` | `{ steps, done, onStep, title, body? }` |  | Steps enable in turn; the rail fills as they are done. |

Full docs: https://beautiful-ui.dev/components/empty-states

## 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 / Enter | Every action is a button |

## Performance

- Small inline SVGs; the only loops are the scan, blink and ping, which stop with motion off.

## Responsive

- Diagrams are 240px wide; lists cap at 380–420px and the actions wrap.

## Motion inventory

| Interaction | What moves |
|---|---|
| No results | A signal line scans the empty ledger (1800ms); bars grow as filters come off (520ms, 60ms apart) |
| Offline | The broken link blinks; the countdown rolls |
| Caught up | Twelve dots pop in, 40ms apart |
| Not found | A ring pings from the signal dot (1600ms) |
| First run | The rail fills to the next node (520ms) |

## Accessibility contract (preserve when editing)
- Diagrams are decorative (aria-hidden); the title and line say everything
- Removing a filter, retrying and stepping are buttons with full names; lists that expand say so (aria-expanded)
- Countdowns and confirmations are announced (aria-live)

## Install

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

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.