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.

API reference

Generated from the types. Every part also takes className.

SearchField

action
string = "/search"The results page.
name
string = "q"The query parameter.
live
boolean = falseTrue on the results page: follow the URL and apply while typing.
onNavigate
(url: string, mode: NavigateMode) => void = browserNavigate
delay
number = 400
label
stringSame as labels.label, and wins over it.
placeholder
stringSame as labels.placeholder, and wins over it.
labels
Partial<SearchFieldLabels>The words it says, to translate them.
hotkey
string = "/"The key that focuses the box; null for none.