Interface: SearchBoxProps
Props for SearchBox.
Extends
Section titled “Extends”Properties
Section titled “Properties”className?
Section titled “className?”
optionalclassName?:string
Extra class names for the outer container.
debounceMs?
Section titled “debounceMs?”
optionaldebounceMs?:number
Debounce in ms before a keystroke triggers a request. Defaults to 200.
Inherited from
Section titled “Inherited from”index?
Section titled “index?”
optionalindex?:string
Which index to search (name or alias). Defaults to the plugin’s default index.
Inherited from
Section titled “Inherited from”limit?
Section titled “limit?”
optionallimit?:number
Max hits to request. Defaults to the plugin’s configured page size.
Inherited from
Section titled “Inherited from”minLength?
Section titled “minLength?”
optionalminLength?:number
Minimum query length before searching. Defaults to 1.
Inherited from
Section titled “Inherited from”
optionalmode?:"hybrid"|"vector"|"keyword"
Match mode. Defaults to the plugin’s configured mode.
Inherited from
Section titled “Inherited from”onSelect?
Section titled “onSelect?”
optionalonSelect?: (hit) =>void
Called when the user picks a hit (click or Enter on a focused row).
Parameters
Section titled “Parameters”fields
Section titled “fields”Record<string, unknown> = ...
string = ...
index?
Section titled “index?”string = ...
number = ...
Returns
Section titled “Returns”void
placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Placeholder text for the input.
renderHit?
Section titled “renderHit?”
optionalrenderHit?: (hit) =>ReactNode
Render one hit row. Defaults to a title + id + score badge.
Parameters
Section titled “Parameters”fields
Section titled “fields”Record<string, unknown> = ...
string = ...
index?
Section titled “index?”string = ...
number = ...
Returns
Section titled “Returns”ReactNode
showIndex?
Section titled “showIndex?”
optionalshowIndex?:boolean
Show the source index name on each hit (useful for universal search).
universal?
Section titled “universal?”
optionaluniversal?:boolean
Search every configured index and merge results (universal search).