Welcome UI - Search

The Search component is an input field designed for querying and retrieving information from a dataset or database. It typically includes features such as autocomplete, suggestions, and filters to enhance the search experience. This component helps users quickly find specific content or data within an application, improving overall usability and efficiency.

Search

dataTestId

string

groupsEnabled

Boolean

hasIcon

Boolean

icon

ReactElement<any, string | JSXElementConstructor<any>>

iconPlacement

"left" | "right" | undefined = left

itemToString

Required

(item: unknown) => string

minChars

number | undefined = 3

onChange

(item: unknown, event: CreateEvent) => void

renderGroupHeader

(result: SearchOptionGroup) => ReactElement<any, string | JSXElementConstructor<any>>

renderItem

Required

(item: unknown) => string | ReactElement<any, string | JSXElementConstructor<any>>

search

Required

(query: string) => Promise<unknown>

size

"xs" | "sm" | "md" | "lg" | undefined = md

throttle

number | undefined = 500

transparent

Boolean

value

unknown

variant

"danger" | "success" | "warning"