Ballmac UI home

Search Field

A compact search control with a clear action, Enter callback, and preserved keyboard focus.

Installation

$ pnpm dlx shadcn@latest add @ballmac/search-field

Usage

import { SearchField } from "@/components/ballmac/search-field"

The full example is in the Code tab above.

Examples

States and variants

API reference

PropTypeDefault
value

Controlled search query.

string—
defaultValue

Initial query when uncontrolled.

string""
onValueChange

Called whenever the query changes or clears.

(value: string) => void—
onSearch

Called when Enter submits the query.

(value: string) => void—
label

Accessible name of the search field.

string—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
EnterSubmits the current query
Tab / SpaceClears the query and returns focus

Quality scorecard

7/7

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    3 tab stops, each showing a visible change when it takes focus. 2 documented keys.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by search-field.test.tsx.

  • For information: Footprint

    1.2 KB of source (gzip) in 1 file. Installs lucide-react.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

A compact search control with a clear action, Enter callback, and preserved keyboard focus. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Search Field (@ballmac/search-field) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Filter a list or catalog
  • Submit a query from a toolbar

Not for

  • Use spotlight-search for site-wide command search

Registry JSON: https://ui.ballmac.com/r/search-field.json

Credits

Free to use in personal and commercial projects.

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.