Interface SearchApi

API to control the Search component imperatively

interface SearchApi {
    resetInput(): void;
    searchAndSelect(inputValue: string): Promise<SelectResult | undefined>;
    setInputValue(inputValue: string): void;
}

Index

Methods

resetInput searchAndSelect setInputValue

Methods

resetInput

resetInput(): void
Clears the search input field.

Returns void
- Defined in src/packages/search/api.ts:151

searchAndSelect

searchAndSelect(inputValue: string): Promise<SelectResult | undefined>
Searches for the specified input value and selects the matching result.
Parameters
- inputValue: string
  The value to search for.
Returns Promise<SelectResult | undefined>
A promise that resolves to the selected SearchResult, or undefined if no matching result is found or selected.
- Defined in src/packages/search/api.ts:167

setInputValue

setInputValue(inputValue: string): void
Sets the search input field to the given value. The suggestion menu is not opened automatically when setting the input value.
Parameters
- inputValue: string
  The value to be set in the search input field.
Returns void
- Defined in src/packages/search/api.ts:158