| Name | Type | Default | Description |
|---|
| AutoCloseDelay | int | 100 | Used only when dropDownOpenMode is set to 'auto'. Determines the delay before the opened drop down closes if the pointer is not over the element. |
| AutoComplete | AutoComplete | AutoComplete.None | Determines the autocomplete mode. Auto complete modes filter the items from the dataSource and show only those that match the input. |
| AutoCompleteDelay | int | 100 | Determines the delay before the drop down opens to show the matches from the auto complete operation. The delay is measured in miliseconds. |
| AutoOpenShortcutKey | string[] | new string[]{} | Allows the user to define a custom key name ( or multiple key names) to open that popup with. |
| DataSource | object | N/A | Determines the data source that will be loaded to the ComboBox. The dataSource can be an array of strings/numbers or objects where the attributes represent the properties of a List Item. For example label, value, group. It can also be a callback that returns an Array of items as previously described. |
| Disabled | bool | false | Enables or disables the combo box. |
| DisplayLoadingIndicator | bool | false | Determines whether an indicator will appear during filtering and remote item loading. |
| DisplayMember | string | "" | Sets or gets the displayMember. The displayMember specifies the name of a property to display. The name is contained in the collection specified by the 'dataSource' property. |
| DropDownAppendTo | string | "null" | Determines the drop down parent. The expected value is CSS Selector, ID or 'body'. The drop down can be removed from the body of the element and continue to work in another container. This is usefull when one of the parents of the element doesn't allow overflowing, by settings this property to 'body' the drop down will be appended to the DOM and the popup will open/close as usual. dropDownAppendTo can be a string representing the id of an HTML element on the page or a direct reference to that element. Reseting it back to null will take the drop down back to it's original place. |
| DropDownButtonPosition | DropDownButtonPosition | DropDownButtonPosition.Right | Determines the position of the drop down button. |
| DropDownHeight | object | | Sets the height of the drop down. By default it's set to an empty string. In this case the height of the drop down is controlled by a CSS variable. |
| DropDownMaxHeight | object | | Sets the maximum Height of the drop down. By default it's set to an empty string. In this case the maxHeight of the drop down is controlled by a CSS variable. |
| DropDownMaxWidth | object | | Sets the maximum Width of the drop down. By default it's set to an empty string. In this case the maxWidth of the drop down is controlled by a CSS variable. |
| DropDownMinHeight | object | | Sets the minimum Height of the drop down. By default it's set to an empty string. In this case the minHeight of the drop down is controlled by a CSS variable. |
| DropDownMinWidth | object | | Sets the minimum Width of the drop down. By default it's set to an empty string. In this case the minWidth of the drop down is controlled by a CSS variable. |
| DropDownOpenMode | DropDownOpenMode | DropDownOpenMode.Default | Determines how the drop down is going to open. |
| DropDownOverlay | bool | false | If this property is enabled, when the element's dropdown is opened, a transparent overlay is positioned between the dropdown and the rest of the document. The purpose of the overlay is to make sure that clicking anywhere outside the popup will will target the overlay and not the DOM. |
| DropDownPlaceholder | string | "No Items" | Determines the placeholder for the drop down, displayed when there are no items in it. |
| DropDownPosition | DropDownPosition | DropDownPosition.Auto | Determines the position of the drop down when opened. |
| DropDownWidth | object | | Sets the width of the drop down. By default it's set to an empty string. In this case the width of the drop down is controlled by a CSS variable. |
| EscKeyMode | ComboBoxEscKeyMode | ComboBoxEscKeyMode.Null | Determines the behavior of the element when Escape key is pressed. |
| Filterable | bool | false | Determines whether filtering is enabled. |
| FilterInputPlaceholder | string | "" | Determines the placeholder for the drop down list filter input field. |
| FilterMode | FilterMode | FilterMode.StartsWithIgnoreCase | Determines the filtering mode of the Combo box. |
| Grouped | bool | false | If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups. |
| GroupMember | string | "" | Determines which attribute from the dataSource object will be used as the group member for the items. If not set, by default 'group' property is used from the source object. groupMember is especially usefull when loading the data from a JSON file as a dataSource for the ListBox and there's a specific property that should be used to group the items. |
| Hint | string | "" | Sets additional helper text below the element. The hint is visible only when the element is focused. |
| HorizontalScrollBarVisibility | HorizontalScrollBarVisibility | HorizontalScrollBarVisibility.Auto | Determines the visibility of the horizontal Scroll bar inside the drop down. |
| InputMember | string | "" | Represents the property name of a List item. Determines the value of the input when a ListItem is selected. Usefull in cases where the user wants to display for example the value of an item instead of it's label. By default the label is displayed in the input. |
| InputPurpose | string | "off" | Sets the purpose of the input and what, if any, permission the user agent has to provide automated assistance in filling out the element's input when in a form, as well as guidance to the browser as to the type of information expected in the element. This value corresponds to the standard HTML autocomplete attribute and can be set to values such as 'on', 'name', 'organization', 'street-address', etc. |
| IncrementalSearchDelay | int | 700 | IncrementalSearchDelay property specifies the time-interval in milliseconds until the previous search query is cleared. The timer starts when the user stops typing. A new query can be started only when the delay has passed. |
| IncrementalSearchMode | SearchMode | SearchMode.StartsWithIgnoreCase | Sets ot gets the mode of the incremental search mode. Incremental search is enabled by default. Typing while the drop down is focused starts the incremental search. |
| ItemHeight | int | N/A | Sets the height for all list items. Used only when virtualization is enabled. |
| ItemMeasureMode | ListItemMeasureMode | ListItemMeasureMode.Auto | Determines the item width measuring algorithm. |
| Items | IEnumerable<object> | | A getter that returns an array of all List items inside the drop down. |
| ItemTemplate | object | N/A | The itemTemplate property is a string that represents the id of an HTMLTemplateElement in the DOM. It's used to set a customize the content of the list items. |
| Label | string | "" | Sets a little text label above the element. |
| LoadingIndicatorPlaceholder | string | "Loading..." | Determines the text that will be displayed next to the loading indicator when the loader is visible and it's position is top or bottom. |
| LoadingIndicatorPosition | VerticalAlignment | VerticalAlignment.Center | Determines the position of the loading indicator. |
| Locale | string | "en" | Sets or gets the language. Used in conjunction with the property messages. |
| Messages | object | N/A | Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. |
| MinLength | int | 2 | Determines the minimum number of characters inside the input in order to trigger the autocomplete functionality |
| Name | string | "" | Sets or gets the name attribute for the element. Name is used when submiting HTML forms. |
| IsOpened | bool | false | Determines whether the popup is opened or closed |
| Placeholder | string | "" | Determines the input's placeholder. |
| Readonly | bool | false | Disables user interaction with the element. |
| RightToLeft | bool | false | Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. |
| ResizeIndicator | bool | false | Determines whether the resize indicator in the bottom right corner of the drop down is visible or not. This property is used in conjunction with resizeMode. |
| ResizeMode | ResizeMode | ResizeMode.Null | Determines whether the dropDown can be resized or not. When resizing is enabled, a resize bar appears on the top/bottom side of the drop down. |
| SelectionDisplayMode | SelectionDisplayMode | SelectionDisplayMode.Plain | Determines what will be displayed in the input. |
| SelectedIndexes | int[] | new int[]{} | Sets or gets the selected indexes. Selected indexes represents an array of the indexes of the items that should be selected. |
| SelectedValues | string[] | new string[]{} | Sets or gets elected indexes. Selected values represents the values of the items that should be selected. |
| SelectionMode | ListSelectionMode | ListSelectionMode.ZeroAndOne | Determines how many items can be selected. |
| Sorted | bool | false | Determines whether the items are sorted alphabetically or not |
| SortDirection | string | "asc" | Determines sorting direction - ascending(asc) or descending(desc) |
| Theme | string | "" | Determines the theme for the element. Themes define the look of the elements. |
| TokenTemplate | object | N/A | Sets a custom content for the tokens when selectionDisplayMode is set to 'tokens'. Tokens are used only for multiple selection. |
| Unfocusable | bool | false | If is set to true, the element cannot be focused. |
| Value | string | "" | Sets or gets the value. |
| ValueMember | string | "" | Determines the value member of an item. Stored as value in the item object. Similar to groupMember, valueMember is especially usefull when using data from a JSON file as a dataSource for the ListBox and there's a specific property that should be used for the value the items. |
| VerticalScrollBarVisibility | VerticalScrollBarVisibility | VerticalScrollBarVisibility.Auto | Determines the visibility of the vertical scroll bar. |
| Virtualized | bool | false | Determines weather or not Virtualization is used for the Combo box. Virtualization allows a huge amount of items to be loaded to the List box while preserving the performance. For example a milion items can be loaded to the list box. |
| Name | Type | Arguments | Description |
|---|
| AppendChild | dynamic | dynamic node | Appends a ListItem to the end of the list of items inside element.Args: dynamic node - A ListItem element that should be added to the rest of the items as the last item. |
| ClearItems | void | N/A | Removes all items from the drop down list. |
| ClearSelection | void | N/A | Unselects all items. |
| Close | void | N/A | Closes the dropDown list. |
| EnsureVisible | void | object item | Ensures the desired item is visible by scrolling to it.Args: object item - A list item or value of the desired item to be visible. |
| GetDataSourceAsync() | Task<IEnumerable<object>> | 'N/A' | Gets the "DataSource" property as Task<IEnumerable<object>>. |
| GetIsOpenedAsync() | Task<bool> | 'N/A' | Gets the "IsOpened" property as Task<bool>. |
| GetItem | object | string value | Returns an item instance from the dropDown list.Args: string value - The value of an item from the drop down list. |
| GetSelectedIndexesAsync() | Task<int[]> | 'N/A' | Gets the "SelectedIndexes" property as Task<int[]>. |
| GetSelectedValuesAsync() | Task<string[]> | 'N/A' | Gets the "SelectedValues" property as Task<string[]>. |
| GetValueAsync() | Task<string> | 'N/A' | Gets the "Value" property as Task<string>. |
| Insert | void | int position, object item | Inserts a new item at a specified position.Args: int position - The position where the item must be inserted.,object item - Describes the properties of the item that will be inserted. |
| InsertBefore | dynamic | dynamic node, dynamic referenceNode | Inserts a new ListItem before another in the list.Args: dynamic node - A ListItem element that should be added before the referenceItem in the list.,dynamic referenceNode - A ListItem element that acts as the reference item before which a new item is about to be inserted. The referenceNode must be in the same list as the node. |
| Open | void | N/A | Opens the dropDown list. |
| Refresh | void | 'N/A' | Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements. |
| RemoveAt | void | int position | Removes an item at a specified position.Args: int position - The position of the removed item. |
| RemoveChild | dynamic | dynamic node | Removes a ListItem from the list of items inside element.Args: dynamic node - A ListItem element that is part of the list of items inside the element. |
| Render | void | 'N/A' | Re-renders the Blazor Component. This method will make a full re-render. |
| Select | void | string item | Selects an item from the dropDown list. Args: string item - A string, representing the value of the item or an HTML Element referencing an item from the list |
| StateHasChanged | void | 'N/A' | Refreshes the state and Re-renders the Blazor Component, if necessary. |
| Unselect | void | string item | Unselects an item from the dropDown list. Args: string item - A string, representing the value of the item or an HTML Element referencing an item from the list |
| Update | void | int position, object value | Updates an item from the dropDown list.Args: int position - The position where the item must be updated.,object value - The value of the updated item. |
| Name | Type | Description | Event Detail |
|---|
| OnChange | EventCallback<Event> | This event is triggered when the selection is changed. | dynamic addedItems- An array of List items that have been selected., dynamic disabled- A flag indicating whether or not the item that caused the change event is disabled., int index- The index of the List item that triggered the event., string label- The label of the List item that triggered the event., dynamic removedItems- An array of List items that have been unselected before the event was fired., dynamic selected- The selected state of the List item that triggered the event. If an item was selected the value will be true and vice versa., dynamic value- The value of the List item that triggered the event. |
| Changed | event ComboBoxChangedEventHandler | This event is triggered when the selection is changed. | ComboBoxChangedEventArgs |
| OnClose | EventCallback<Event> | This event is triggered when the drop down list is closed. | N/A |
| Closed | event ComboBoxClosedEventHandler | This event is triggered when the drop down list is closed. | ComboBoxClosedEventArgs |
| OnClosing | EventCallback<Event> | This event is triggered when the drop down list is about to be closed. This event allows to cancel the closing operation calling event.preventDefault() in the event handler function. | N/A |
| Closing | event ComboBoxClosingEventHandler | This event is triggered when the drop down list is about to be closed. This event allows to cancel the closing operation calling event.preventDefault() in the event handler function. | ComboBoxClosingEventArgs |
| OnItemClick | EventCallback<Event> | This event is triggered when an item is clicked. | dynamic disabled- Indicates whether the List item that was clicked is disabled or not., int index- Indicates the index of the List item that was clicked., string label- The label of the List item that was clicked., dynamic selected- Indicates whether the List item that was clicked is selected or not., dynamic value- The value of the List item that was clicked. |
| ItemClicked | event ComboBoxItemClickedEventHandler | This event is triggered when an item is clicked. | ComboBoxItemClickedEventArgs |
| OnOpen | EventCallback<Event> | This event is triggered when the drop down list is opened. | N/A |
| Opened | event ComboBoxOpenedEventHandler | This event is triggered when the drop down list is opened. | ComboBoxOpenedEventArgs |
| OnOpening | EventCallback<Event> | This event is triggered when the drop down list is about to be opened. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function. | N/A |
| Opening | event ComboBoxOpeningEventHandler | This event is triggered when the drop down list is about to be opened. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function. | ComboBoxOpeningEventArgs |
| OnResizeStart | EventCallback<Event> | This event is triggered when user starts resizing the drop down. | dynamic position- An object containing the current left and top positions of the drop down. |
| ResizeStarted | event ComboBoxResizeStartedEventHandler | This event is triggered when user starts resizing the drop down. | ComboBoxResizeStartedEventArgs |
| OnResizeEnd | EventCallback<Event> | This event is triggered when the resizing of the drop down is finished. | dynamic position- An object containing the current left and top positions of the drop down. |
| ResizeEnded | event ComboBoxResizeEndedEventHandler | This event is triggered when the resizing of the drop down is finished. | ComboBoxResizeEndedEventArgs |
| OnScrollBottomReached | EventCallback<Event> | This event is triggered when user scrolls to the end of the dropDown list. | N/A |
| ScrollBottomReached | event ComboBoxScrollBottomReachedEventHandler | This event is triggered when user scrolls to the end of the dropDown list. | ComboBoxScrollBottomReachedEventArgs |
| OnScrollTopReached | EventCallback<Event> | This event is triggered when user scrolls to the start of the dropDown list. | N/A |
| ScrollTopReached | event ComboBoxScrollTopReachedEventHandler | This event is triggered when user scrolls to the start of the dropDown list. | ComboBoxScrollTopReachedEventArgs |
| OnTokenClick | EventCallback<Event> | This event is triggered when a token item(pill) has been clicked. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function. | N/A |
| TokenClicked | event ComboBoxTokenClickedEventHandler | This event is triggered when a token item(pill) has been clicked. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function. | ComboBoxTokenClickedEventArgs |