# Search field (Notchset): prompt.md (v2.0.0)
- id: `search-field` · 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/search-field.json`
- npm dependencies: lucide-react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/keyboard-hint
- docs: https://notchset.dev/components/search-field
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.
Filters what is on the page as you type. Esc clears it, a clear button appears once there is text, and a printed shortcut key focuses it. Dense beside a table's tabs or wide at the top of a list..
## 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: `lucide-react@^1`.
- Files: `components/ui/notchset/search-field.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `keyboard-hint`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `SearchField`, 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`, `--ns-control-sm`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-radius`, `--ns-signal`, `--ns-text-body`, `--ns-time-color`, `--ns-well`.
- 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 { SearchField } from "@/components/ui/notchset/search-field";
```
## Parts
- A single export that takes props.
## Match the original
- Read `components/ui/notchset/search-field.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
- keyboard-hint (`keyboard-hint`), 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 { SearchField } from "@/components/ui/notchset/search-field";
const COMPANIES = ["Airtable", "Stripe", "Revolut", "Webflow", "PostHog"];
export default function SearchFieldDemo() {
const [query, setQuery] = React.useState("");
const shown = COMPANIES.filter((c) => c.toLowerCase().includes(query.toLowerCase()));
return (
{shown.length ? shown.map((c) =>
{c}
) :
No companies match “{query}”
}
);
}
```
## Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| `value` | `string` | | Required. |
| `onValueChange` | `(value: string) => void` | | Required. |
| `shortcut` | `string` | | A single key that focuses the field from anywhere on the page ("/"). |
| `size` | `"dense" \| "wide"` | `"dense"` | |
Full docs: https://notchset.dev/components/search-field
## 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/search-field.json
```
Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/search-field`. Every components.json style gets the same files.
## Continue the workflow
- [Data table](https://notchset.dev/blocks/data-table)
- [View tabs](https://notchset.dev/blocks/view-tabs)
- [Sortable header](https://notchset.dev/components/sortable-header)
## Source
### components/ui/notchset/search-field.tsx
```tsx
// Notchset search-field 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { Search, X } from "lucide-react";
import { cn } from "@/lib/utils";
import { KeyboardHint } from "@/components/ui/notchset/keyboard-hint";
/*
* Search field: filters what is on the page as you type. Esc clears it (then leaves it); a clear button
* appears once there is text. Dense (28px) beside a table's tabs, or wide (32px) at the top of a list.
* `shortcut` prints the key that focuses it, and binds it: a printed key always works.
*/
type SearchFieldProps = Omit, "onChange" | "value" | "defaultValue" | "size"> & {
value: string;
onValueChange: (value: string) => void;
/** A single key that focuses the field from anywhere on the page ("/"). */
shortcut?: string | undefined;
size?: "dense" | "wide" | undefined;
};
const SearchField = React.forwardRef(function SearchField(
{ value, onValueChange, shortcut, size = "dense", className, placeholder = "Search", "aria-label": ariaLabel, onKeyDown, disabled, readOnly, ...props },
forwarded,
) {
const inner = React.useRef(null);
React.useImperativeHandle(forwarded, () => inner.current!);
/* a disabled or read-only field can't be changed from anywhere: not by typing, Esc, the clear button or the shortcut */
const locked = !!disabled || !!readOnly;
React.useEffect(() => {
if (!shortcut || disabled) return;
const onKey = (e: KeyboardEvent) => {
const t = e.target as HTMLElement;
if (e.key !== shortcut || e.metaKey || e.ctrlKey || e.altKey || t.closest("input,textarea,select,[contenteditable=true]")) return;
e.preventDefault();
inner.current?.focus();
};
document.addEventListener("keydown", onKey);
return () => document.removeEventListener("keydown", onKey);
}, [shortcut, disabled]);
return (
onValueChange(e.target.value)}
onKeyDown={(e) => {
onKeyDown?.(e);
if (e.key === "Escape" && value && !locked) {
e.preventDefault();
e.stopPropagation();
onValueChange("");
} else if (e.key === "Escape" && !value) inner.current?.blur();
}}
className="min-w-0 flex-1 bg-transparent text-[length:var(--ns-text-body)] text-[var(--ns-ink)] outline-hidden placeholder:text-[var(--ns-ink-3)] pointer-coarse:text-[16px] [&::-webkit-search-cancel-button]:hidden"
{...props}
/>
{value ? (
) : shortcut ? (
) : null}
);
});
export { SearchField, type SearchFieldProps };
```
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.