HxAutosuggest

Component for single item selection with dynamic suggestions (based on typed characters).

Current value: 1033

API

Parameters

Name Type Description
AdditionalAttributes IReadOnlyDictionary<string, object> A collection of additional attributes that will be applied to the created element.
ChipTemplate RenderFragment Chip template.
ClearIcon IconBase Icon displayed in input on selection clear button when item is selected.
CssClass string Custom CSS class to render with wrapping div.
DataProvider AutosuggestDataProviderDelegate<TItem> Method (delegate) which provides data of the suggestions.
Delay int? Debounce delay in miliseconds.
DisplayName string
EmptyTemplate RenderFragment Template to display when items are empty.
Enabled bool? When null (default), the Enabled value is received from cascading FormState. When value is false, input is rendered as disabled. To set multiple controls as disabled use HxFormState.
GenerateChip bool When true, HxChipGenerator is used to generate chip item(s). Default is true.
Hint string Hint to render after input as form-text.
HintTemplate RenderFragment Hint to render after input as form-text.
InputCssClass string Custom CSS class to render with the input element.
InputGroupEndTemplate RenderFragment Input-group at the end of the input.
Hides the search icon when used!
InputGroupEndText string Input-group at the end of the input.
Hides the search icon when used!
InputGroupStartTemplate RenderFragment Input-group at the beginning of the input.
InputGroupStartText string Input-group at the beginning of the input.
InputSize InputSize? Size of the input.
ItemFromValueResolver Func<TValue, Task<TItem>> Returns corresponding item for (select) Value.
ItemTemplate RenderFragment<TItem> Template to display item. When not set, TextSelector is used.
Label string Label text.
LabelCssClass string Custom CSS class to render with the label.
LabelTemplate RenderFragment Label content.
LabelType LabelType? Label type.
MinimumLength int? Minimal number of characters to start suggesting.
Placeholder string Short hint displayed in the input field before the user enters a value.
SearchIcon IconBase Icon displayed in input when no item is selected.
Settings AutosuggestSettings Set of settings to be applied to the component instance (overrides HxAutosuggest.Defaults, overriden by individual parameters).
TextSelector Func<TItem, string> Selects text to display from item. When not set ToString() is used.
ValidationMessageMode ValidationMessageMode? Specifies how the validation message should be displayed.
Default is ValidationMessageMode.Regular, you can override application-wide default for all inputs in HxInputBase.Defaults.
Value TValue Value of the input. This should be used with two-way binding.
ValueChanged EventCallback<TValue> A callback that updates the bound value.
ValueExpression Expression<Func<TValue>> An expression that identifies the bound value.
ValueSelector Func<TItem, TValue> Selects value from item. Not required when TValue is same as TItem.

Methods

Method Returns Description
FocusAsync() ValueTask Gives focus to the input element.

Static properties

Property Type Description
Defaults AutosuggestSettings Application-wide defaults for the HxAutosuggest and derived components.

CSS Variables

Name Description Default
--hx-autosuggest-input-close-icon-opacity Opacity of the close icon. .25
--hx-autosuggest-item-highlighted-background-color When HxAutosuggest.HighlightFirstSuggestion is true, then the first item receives this background color. var(--bs-gray-200)
An unhandled error has occurred. Reload 🗙