AutoSuggestProps Interface

Properties for the AutoSuggest component.

Extends

Methods

Name Description
getLabel(value: undefined | string): string Optional Gets a label associated with a given value  
onInputFocus(e: FocusEvent<HTMLInputElement, Element>): void Optional Handler for input receiving focus.  
onPressEnter(e: KeyboardEvent<HTMLInputElement>): void Optional Handler for Enter key.  
onPressEscape(e: KeyboardEvent<HTMLInputElement>): void Optional Handler for Escape key.  
onPressTab(e: KeyboardEvent<HTMLInputElement>): void Optional Handler for Tab key.  
onSuggestionSelected(selected: AutoSuggestData): void Handler for when suggested selected.  
onSuggestionsClearRequested(): void Optional Called every time you need to clear suggestions.  

Properties

Name Type Description
getSuggestions undefined | AsyncGetAutoSuggestDataFunc Asynchronously calculate suggestions for any given input value.  
options GetAutoSuggestDataFunc | AutoSuggestData[] Options for dropdown.  
setFocus undefined | boolean Indicates whether to set focus to the input element  
value undefined | string Optional input value override.  

Inherited properties

Name Type Inherited from Description
itemId undefined | string CommonProps Optional unique identifier for item.

Defined in

Last Updated: 20 June, 2023