Skip to content
Design System
GitHub

Search field

v0.23.0

The tool's one search box: / focuses it, Enter opens the results page, and on that page it follows ?q= and applies as you type.

Press / anywhere, type, then Enter.

Search field in top bar

Install
npx shadcn add @syncrobotic/search-field

Also installs: lucide-react, @syncrobotic/cn, @syncrobotic/filter-form, @syncrobotic/input, @syncrobotic/input-group, @syncrobotic/kbd

Overview

When to use

  • The search in an app's top bar.
  • The query box on a results page (live).

Use something else

  • Filtering a list on the page: an Input group with a search icon.
  • Picking from a known list as you type: Autocomplete.

More examples

States and real uses. Each example is also a Storybook story and a visual regression test.

On the results page it applies as you type.

Search field on results page

Usage rules

  • One search box per tool, in the top bar. / focuses it; Enter opens the results page.
  • On the results page set live: it mirrors ?q= and applies as you type.
  • For jumping to pages and actions use the command palette (AppShell search); this is for searching data.

Changelog

  • 0.23.02026-11-20Every word it says can be translated without editing the source: labels (label, placeholder); the props of the same names still work and win.
  • 0.10.02026-11-18New.

How to upgrade