# Filter button (Notchset): prompt.md (v2.0.0) - id: `filter-button` · version 2.0.0 · component · free - category: Inputs - build: one set of files for every shadcn style - install: `npx shadcn@latest add https://notchset.dev/r/filter-button.json` - npm dependencies: none - registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/menu - docs: https://notchset.dev/components/filter-button - The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand. One facet of a list (Stage, Owner). Unused it is a dashed outline; once something is picked it turns solid and counts the picks. Its menu stays open while you tick several, with Clear at the bottom.. ## Build it - Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases). - Packages: none beyond React. - Files: `components/ui/notchset/filter-button.tsx`. - Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `menu`. - Builds: one set of files, the same for every shadcn style. - Exports to keep: `FilterButton`, and every exported type. - CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) 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. - Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component. - This item reads `--ns-control-sm`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-radius`, `--ns-selected`, `--ns-signal`, `--ns-text-body`, `--ns-text-meta`, `--ns-text-small`, `--ns-time-color`, `--ns-weight-medium`. - Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`. - Never add Tailwind colour classes inside the component. ```tsx import { FilterButton } from "@/components/ui/notchset/filter-button"; ``` ## Parts - A single export that takes props. ## Match the original - Read `components/ui/notchset/filter-button.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 ### Not when ## Built from - menu (`menu`), installed with it: reuse it, don't rebuild it ## Mistakes - Recreating the component instead of installing it ## Usage ```tsx "use client"; import * as React from "react"; import { Filter, UserRound } from "lucide-react"; import { FilterButton } from "@/components/ui/notchset/filter-button"; const STAGES = { Discovery: "#8f9bb3", Evaluation: "#38a6d6", Proposal: "#9b87f5", "Security review": "#e3a33b", Procurement: "#ec7d55" }; const OWNERS = ["Ana Ruiz", "Kevin Ito", "Priya Shah", "Marcus Bell"]; export default function FilterButtonDemo() { const [stages, setStages] = React.useState(["Proposal"]); const [owners, setOwners] = React.useState([]); return (
} value={stages} onValueChange={setStages} options={Object.entries(STAGES).map(([k, c]) => ({ value: k, label: k, icon: }))} /> } value={owners} onValueChange={setOwners} options={OWNERS.map((o) => ({ value: o, label: o }))} />
); } ``` ## Props | Prop | Type | Default | What it does | |---|---|---|---| | `label` | `string` | | Required. | | `icon` | `React.ReactNode` | | | | `options` | `FilterOption[]` | | Required. | | `value` | `string[]` | | Required. | | `onValueChange` | `(value: string[]) => void` | | Required. | Full docs: https://notchset.dev/components/filter-button ## Customising - Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component. - Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions). - Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build. ## Accessibility contract (preserve when editing) ## Install ```bash npx shadcn@latest add https://notchset.dev/r/filter-button.json ``` Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/filter-button`. Every components.json style gets the same files. ## Continue the workflow - [Chip](https://notchset.dev/components/chip) - [Combobox](https://notchset.dev/components/combobox) - [Property pill](https://notchset.dev/components/property-pill) ## Source ### components/ui/notchset/filter-button.tsx ```tsx // Notchset filter-button 2.0.0 · https://notchset.dev/changelog "use client"; import * as React from "react"; import { cn } from "@/lib/utils"; import { Menu, MenuCheckboxItem, MenuItem, MenuSeparator } from "@/components/ui/notchset/menu"; /* * Filter button: one facet of a list (Stage, Owner). Unused, it is a dashed outline that says "you can narrow * this"; once something is picked it turns solid and counts the picks. It opens a menu of checkable options * that stays open while you tick several, with Clear at the bottom. The picks also show as chips under the bar. * Options can carry a count (how many rows the pick would leave); a menu with no options says so. */ type FilterOption = { value: string; label: string; icon?: React.ReactNode; count?: number }; type FilterButtonProps = { label: string; icon?: React.ReactNode; options: FilterOption[]; value: string[]; onValueChange: (value: string[]) => void; className?: string | undefined; }; function FilterButton({ label, icon, options, value, onValueChange, className }: FilterButtonProps) { const on = value.length > 0; return ( {icon} {label} {on && {value.length}} } > {options.length === 0 &&
Nothing left with the other filters on
} {options.map((o) => ( onValueChange(c ? [...value, o.value] : value.filter((v) => v !== o.value))} > {o.label} {o.count !== undefined && {o.count}} ))} {on && ( <> onValueChange([])} className="text-[var(--ns-ink-2)]"> Clear {label.toLowerCase()} )} ); } export { FilterButton, type FilterButtonProps, type FilterOption }; ``` The foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://notchset.dev/r/notchset-foundation.json.