# Filter Toolbar (Notchset): prompt.md (v1.0.0)

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

A controlled filter bar: search, FIELD · VALUE chips that open their values or fold away, a field-then-values menu with live counts and drawn checks, a rolling count, and clear all; it holds no data.

## 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/filter-toolbar.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/calendar.tsx`.
- 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: `FilterToolbar`, 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-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

```tsx
import { FilterToolbar, type FilterField, type FilterValue } from "@/components/ui/notchset/filter-toolbar";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `FilterToolbar` | `filter-toolbar` | The bar. |
| `—` | `filter-chip` | A chip. |

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/filter-toolbar.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
- filter toolbar, filter bar, faceted filters, table filters, chips, search and filter, Notchset
- Filtering a list or table by a few fields with known values

### Not when
- One field: use Select or Segmented Control

## Mistakes
- Filter in the parent and pass count: the toolbar never sees your rows

## Usage

```tsx
"use client";

import * as React from "react";
import { FilterToolbar, type FilterField, type FilterValue } from "@/components/ui/notchset/filter-toolbar";

type Run = { id: string; agent: string; status: string };
const all: Run[] = [
  { id: "run_1", agent: "Planner", status: "ok" },
  { id: "run_2", agent: "Triage", status: "fail" },
  { id: "run_3", agent: "Planner", status: "fail" },
];
const fields: FilterField[] = [
  { key: "agent", label: "AGENT", options: ["Planner", "Triage"] },
  { key: "status", label: "STATUS", options: ["ok", "fail"] },
];

export function RunFilters() {
  const [filters, setFilters] = React.useState<FilterValue>({});
  const rows = all.filter((r) => Object.entries(filters).every(([k, vs]) => !vs.length || vs.includes(String(r[k as keyof Run]))));
  return <FilterToolbar fields={fields} value={filters} onValueChange={setFilters} count={rows.length} total={all.length} unit="RUNS" />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `fields` | `{ key, label, options }[]` |  | What can be filtered. |
| `value / onValueChange` | `Record<key, string[]>` |  | Controlled. |
| `query / onQueryChange` | `string` |  | The search. |
| `count / total / unit` | `number / number / string` |  | n OF m UNIT. |
| `optionCount` | `(field, option) => number` |  | Counts in the menu. |
| `onFiltersChange` | `(value, query) => void` |  | Every change. |

Full docs: https://beautiful-ui.dev/components/filter-toolbar

## 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 a chip or ADD |
| ↑ / ↓ | Move in the menu |
| Esc | Close |

## Performance

- No data inside; renders only chips and the open menu.

## Responsive

- Wraps onto a second row when chips don't fit.

## Motion inventory

| Interaction | What moves |
|---|---|
| Menu | Unrolls (320ms) under its trigger; closes in 140ms |
| Remove | The chip folds (260ms), then the filter clears |
| Checks | Draw in (220ms) |

## Accessibility contract (preserve when editing)
- A toolbar; chips are buttons with labels; the menu is a dialog of checkbox rows
- Esc closes and returns focus; the count is live

## Install

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

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.