ComboBox — Smart UI React API

// src/main.tsx
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
);

// src/App.tsx
import { useEffect, useRef } from 'react';
import 'smart-webcomponents/source/styles/smart.default.css';
import { ComboBox } from 'smart-webcomponents-react/combobox';

export default function App() {
  const ref = useRef<ComboBox | null>(null);

  useEffect(() => {
    const el = ref.current as any;
    if (!el) return;

    el.dataSource = ['Espresso', 'Latte', 'Cappuccino', 'Mocha'];
    el.autoComplete = 'auto';
    el.selectedIndexes = [1];
    el.addEventListener('change', (event: any) => console.log('change:', event.detail ?? event));
  }, []);

  return <ComboBox ref={ref} id="demo-combobox" />;
}

Component

ComboBox

ComboBox is the alternate for the HTML select tag with editable option. It supports data binding, auto-complete, filtering, grouping, cascading and more.

Selector

<ComboBox>

Properties

Events

Methods

Properties

autoCloseDelayThis property is applicable only when dropDownOpenMode is set to 'auto'. It specifies the amount of time (in milliseconds) the dropdown will remain open after the pointer leaves the element, before it automatically closes. If the pointer is not hovering over the dropdown or its trigger element, the dropdown will close after this delay.number

This property is applicable only when dropDownOpenMode is set to 'auto'. It specifies the amount of time (in milliseconds) the dropdown will remain open after the pointer leaves the element, before it automatically closes. If the pointer is not hovering over the dropdown or its trigger element, the dropdown will close after this delay.

<ComboBox autoCloseDelay={50} />

comboboxRef.current!.autoCloseDelay = 200;

const autoCloseDelay = comboboxRef.current!.autoCloseDelay;

autoCompleteSpecifies the autocomplete mode for the input field. The selected mode defines how the component filters and displays items from the dataSource, showing only those entries that match the user's input according to the chosen matching strategy. This setting directly impacts the suggestions presented to the user as they type."none" | "auto" | "inline" | "manual"

Specifies the autocomplete mode for the input field. The selected mode defines how the component filters and displays items from the dataSource, showing only those entries that match the user's input according to the chosen matching strategy. This setting directly impacts the suggestions presented to the user as they type.

Allowed Values

• "none" - Auto complete is disabled.
• "auto" - When the input matches one or many items from the dataSource the drop down opens and displays the matched items. The first suggested item is automatically highlighted as selected and becomes the value of the textbox when the combobox loses focus unless the user chooses a different item or changes the character string in the textbox.
• "inline" - When the input matches one or many items from the dataSource the drop down opens and displays the matched items. The first suggested item is automatically highlighted as selected and becomes the value of the textbox when the combobox loses focus unless the user chooses a different item or changes the character string in the textbox. In addition to that a completion helper that appears next to the input cursor in the input. This helper shows the first possible match by completing the input text.
• "manual" - When the input matches one or many items from the dataSource the drop down opens and displays the matched items.

<ComboBox autoComplete="auto" />

comboboxRef.current!.autoComplete = "manual";

const autoComplete = comboboxRef.current!.autoComplete;

autoCompleteDelaySpecifies the amount of time, in milliseconds, to wait after the user input before displaying the dropdown list of autocomplete suggestions. This delay helps control how quickly the suggestions appear, allowing for smoother user experience and reducing unnecessary searches as the user types.number

Specifies the amount of time, in milliseconds, to wait after the user input before displaying the dropdown list of autocomplete suggestions. This delay helps control how quickly the suggestions appear, allowing for smoother user experience and reducing unnecessary searches as the user types.

<ComboBox autoCompleteDelay={250} />

comboboxRef.current!.autoCompleteDelay = 500;

const autoCompleteDelay = comboboxRef.current!.autoCompleteDelay;

autoOpenShortcutKeyEnables users to specify one or more custom key names that will trigger the opening of the popup when pressed. This allows for flexible keyboard shortcuts tailored to user preferences or application requirements. string[]

Enables users to specify one or more custom key names that will trigger the opening of the popup when pressed. This allows for flexible keyboard shortcuts tailored to user preferences or application requirements.

<ComboBox autoOpenShortcutKey="["ArrowUp", "ArrowDown"]" />

comboboxRef.current!.autoOpenShortcutKey = ["ArrowDown"];

const autoOpenShortcutKey = comboboxRef.current!.autoOpenShortcutKey;

dataSourceSpecifies the source of data to populate the ComboBox. The dataSource can be provided in several formats:- An array of strings or numbers, where each item becomes a selectable option in the ComboBox.- An array of objects, where each object represents a list item and its properties define the displayed information and associated value (e.g., label for display text, value for the underlying value, and optionally group to categorize items).- A callback function that returns an array of items in either of the above formats, enabling dynamic or asynchronous data loading.This flexible dataSource configuration allows the ComboBox to support simple lists, categorized lists, or dynamically retrieved data.any

Specifies the source of data to populate the ComboBox. The dataSource can be provided in several formats:

- An array of strings or numbers, where each item becomes a selectable option in the ComboBox.
- An array of objects, where each object represents a list item and its properties define the displayed information and associated value (e.g., label for display text, value for the underlying value, and optionally group to categorize items).
- A callback function that returns an array of items in either of the above formats, enabling dynamic or asynchronous data loading.

This flexible dataSource configuration allows the ComboBox to support simple lists, categorized lists, or dynamically retrieved data.

<ComboBox dataSource="["item 1", "item 2"]" />

comboboxRef.current!.dataSource = ["new item 1", "new item 2"];

const dataSource = comboboxRef.current!.dataSource;

disabledControls whether the combo box is active or inactive. When enabled, users can interact with the combo box to select or enter a value. When disabled, the combo box is non-interactive and appears grayed out, preventing any user input or selection.boolean

Controls whether the combo box is active or inactive. When enabled, users can interact with the combo box to select or enter a value. When disabled, the combo box is non-interactive and appears grayed out, preventing any user input or selection.

<ComboBox disabled={true} />

comboboxRef.current!.disabled = false;

const disabled = comboboxRef.current!.disabled;

displayLoadingIndicatorSpecifies whether a visual indicator (such as a loading spinner or progress bar) will be displayed while filtering data locally or when retrieving items from a remote source. This helps inform users that a filtering operation or data fetch is in progress.boolean

Specifies whether a visual indicator (such as a loading spinner or progress bar) will be displayed while filtering data locally or when retrieving items from a remote source. This helps inform users that a filtering operation or data fetch is in progress.

<ComboBox displayLoadingIndicator={true} />

comboboxRef.current!.displayLoadingIndicator = false;

const displayLoadingIndicator = comboboxRef.current!.displayLoadingIndicator;

displayMemberSets or retrieves the displayMember property. The displayMember property defines the specific field name within each data object in the collection provided by the 'dataSource' property. This field's value is used for displaying items in the UI component, allowing you to control which attribute of your data objects is shown to the user.string

Sets or retrieves the displayMember property. The displayMember property defines the specific field name within each data object in the collection provided by the 'dataSource' property. This field's value is used for displaying items in the UI component, allowing you to control which attribute of your data objects is shown to the user.

<ComboBox displayMember="label" />

comboboxRef.current!.displayMember = "name";

const displayMember = comboboxRef.current!.displayMember;

dropDownAppendToSpecifies the parent container for the dropdown element. The dropDownAppendTo property accepts a CSS selector string, an element's ID, the string value 'body', or a direct reference to an HTML element. By default, the dropdown is appended to its original parent in the DOM. However, if one of the containing elements has CSS properties (such as overflow: hidden) that restrict the dropdown's visibility, you can set this property—commonly to 'body'—to append the dropdown directly to the <body> element and ensure it displays properly.Possible values:- A CSS selector string (e.g., '.container' or '#mainDiv')- The string 'body'- A direct reference to an existing HTML element- An element's ID (as a string)- null (to reset and move the dropdown back to its original parent)This property improves compatibility in layouts with restricted overflow by allowing the dropdown to be rendered in a container of your choosing. Resetting dropDownAppendTo to null restores the dropdown to its initial placement within the DOM.string

Specifies the parent container for the dropdown element. The dropDownAppendTo property accepts a CSS selector string, an element's ID, the string value 'body', or a direct reference to an HTML element. By default, the dropdown is appended to its original parent in the DOM. However, if one of the containing elements has CSS properties (such as overflow: hidden) that restrict the dropdown's visibility, you can set this property—commonly to 'body'—to append the dropdown directly to the <body> element and ensure it displays properly.

Possible values:
- A CSS selector string (e.g., '.container' or '#mainDiv')
- The string 'body'
- A direct reference to an existing HTML element
- An element's ID (as a string)
- null (to reset and move the dropdown back to its original parent)

This property improves compatibility in layouts with restricted overflow by allowing the dropdown to be rendered in a container of your choosing. Resetting dropDownAppendTo to null restores the dropdown to its initial placement within the DOM.

<ComboBox dropDownAppendTo="body" />

comboboxRef.current!.dropDownAppendTo = null;

const dropDownAppendTo = comboboxRef.current!.dropDownAppendTo;

dropDownButtonPositionSpecifies the location of the dropdown button relative to its associated input field or container. Possible positions may include "left," "right," "top," or "bottom," allowing developers to control where the dropdown button appears in the user interface."left" | "right" | "top" | "bottom"

Specifies the location of the dropdown button relative to its associated input field or container. Possible positions may include "left," "right," "top," or "bottom," allowing developers to control where the dropdown button appears in the user interface.

Allowed Values

• "left" - Positions the drop down button on the left side of the element.
• "right" - Positions the drop down button on the right side of the element.
• "top" - Positions the drop down button on the top side of the element.
• "bottom" - Positions the drop down button on the bottom side of the element.

<ComboBox dropDownButtonPosition="left" />

comboboxRef.current!.dropDownButtonPosition = "right";

const dropDownButtonPosition = comboboxRef.current!.dropDownButtonPosition;

dropDownHeightSpecifies the height of the dropdown menu. By default, this property is set to an empty string, which means the dropdown’s height will be determined by the corresponding CSS variable. If a specific value is provided, it will override the CSS variable and set the dropdown height explicitly.string | number

Specifies the height of the dropdown menu. By default, this property is set to an empty string, which means the dropdown’s height will be determined by the corresponding CSS variable. If a specific value is provided, it will override the CSS variable and set the dropdown height explicitly.

<ComboBox dropDownHeight="auto" />

comboboxRef.current!.dropDownHeight = 500;

const dropDownHeight = comboboxRef.current!.dropDownHeight;

dropDownMaxHeightSpecifies the maximum height of the dropdown menu. By default, this value is set to an empty string, which means the dropdown's max-height will be controlled by a CSS variable instead of an explicit value. If you provide a specific value (e.g., "300px" or "50vh"), it will override the default CSS variable and directly set the maximum height of the dropdown.string | number

Specifies the maximum height of the dropdown menu. By default, this value is set to an empty string, which means the dropdown's max-height will be controlled by a CSS variable instead of an explicit value. If you provide a specific value (e.g., "300px" or "50vh"), it will override the default CSS variable and directly set the maximum height of the dropdown.

<ComboBox dropDownMaxHeight="800" />

comboboxRef.current!.dropDownMaxHeight = 1000;

const dropDownMaxHeight = comboboxRef.current!.dropDownMaxHeight;

dropDownMaxWidthDefines the maximum width of the dropdown menu. By default, this value is set to an empty string, which means the dropdown's maximum width will be determined by a corresponding CSS variable. If a specific value is provided (e.g., "300px" or "50%"), it will override the CSS variable and directly set the maximum width of the dropdown.string | number

Defines the maximum width of the dropdown menu. By default, this value is set to an empty string, which means the dropdown's maximum width will be determined by a corresponding CSS variable. If a specific value is provided (e.g., "300px" or "50%"), it will override the CSS variable and directly set the maximum width of the dropdown.

<ComboBox dropDownMaxWidth="500" />

comboboxRef.current!.dropDownMaxWidth = 800;

const dropDownMaxWidth = comboboxRef.current!.dropDownMaxWidth;

dropDownMinHeightDefines the minimum height of the dropdown component. By default, this property is set to an empty string, which means the dropdown's minimum height is determined by a corresponding CSS variable. If a specific value is provided for this property, it will override the CSS variable and explicitly set the dropdown's minimum height.string | number

Defines the minimum height of the dropdown component. By default, this property is set to an empty string, which means the dropdown's minimum height is determined by a corresponding CSS variable. If a specific value is provided for this property, it will override the CSS variable and explicitly set the dropdown's minimum height.

<ComboBox dropDownMinHeight="50" />

comboboxRef.current!.dropDownMinHeight = 150;

const dropDownMinHeight = comboboxRef.current!.dropDownMinHeight;

dropDownMinWidthSpecifies the minimum width of the dropdown component. By default, this property is set to an empty string (""). When left unset, the dropdown’s minimum width is determined by a CSS variable, allowing for flexible styling through external stylesheets. To override the CSS value, assign a specific width value (e.g., "200px" or "10rem") to this property.string | number

Specifies the minimum width of the dropdown component. By default, this property is set to an empty string (""). When left unset, the dropdown’s minimum width is determined by a CSS variable, allowing for flexible styling through external stylesheets. To override the CSS value, assign a specific width value (e.g., "200px" or "10rem") to this property.

<ComboBox dropDownMinWidth="100" />

comboboxRef.current!.dropDownMinWidth = 90;

const dropDownMinWidth = comboboxRef.current!.dropDownMinWidth;

dropDownOpenModeSpecifies the direction or animation in which the dropdown menu will appear when activated, such as opening upwards, downwards, or with a specific transition effect."none" | "default" | "dropDownButton" | "auto"

Specifies the direction or animation in which the dropdown menu will appear when activated, such as opening upwards, downwards, or with a specific transition effect.

Allowed Values

• "none" - The drop down can't be opened.
• "default" - The drop down opens when the user clicks on the element
• "dropDownButton" - The element is split in two button: action and drop down buttons. The drop down opens only when the button is clicked. The action button fires a custom event when clicked on. The event can be used to execute a custom operation on click.
• "auto" - The drop down opens when the element is hovered and closes when not.

<ComboBox dropDownOpenMode="dropDownButton" />

comboboxRef.current!.dropDownOpenMode = "auto";

const dropDownOpenMode = comboboxRef.current!.dropDownOpenMode;

dropDownOverlayIf this property is enabled, opening the element's dropdown will insert a transparent overlay between the dropdown and the rest of the document. This overlay covers the entire viewport except for the dropdown itself, capturing all click events outside the dropdown. As a result, any clicks outside the popup will interact with the overlay instead of other elements on the page, allowing you to reliably detect and handle outside clicks (such as to close the dropdown) without unintentionally triggering other DOM elements.boolean

If this property is enabled, opening the element's dropdown will insert a transparent overlay between the dropdown and the rest of the document. This overlay covers the entire viewport except for the dropdown itself, capturing all click events outside the dropdown. As a result, any clicks outside the popup will interact with the overlay instead of other elements on the page, allowing you to reliably detect and handle outside clicks (such as to close the dropdown) without unintentionally triggering other DOM elements.

<ComboBox dropDownOverlay={true} />

comboboxRef.current!.dropDownOverlay = false;

const dropDownOverlay = comboboxRef.current!.dropDownOverlay;

dropDownPlaceholderSpecifies the text or content to be shown in the dropdown as a placeholder when the dropdown contains no selectable items. This placeholder provides guidance or context to the user, indicating that there are currently no available options.string

Specifies the text or content to be shown in the dropdown as a placeholder when the dropdown contains no selectable items. This placeholder provides guidance or context to the user, indicating that there are currently no available options.

<ComboBox dropDownPlaceholder="No Items" />

comboboxRef.current!.dropDownPlaceholder = "Empty";

const dropDownPlaceholder = comboboxRef.current!.dropDownPlaceholder;

dropDownPositionSpecifies the placement of the dropdown menu relative to its trigger element when opened (e.g., above, below, left, or right). This setting controls where the dropdown appears on the screen in relation to the element that activates it."auto" | "top" | "bottom" | "overlay-top" | "overlay-center" | "overlay-bottom" | "center-bottom" | "center-top"

Specifies the placement of the dropdown menu relative to its trigger element when opened (e.g., above, below, left, or right). This setting controls where the dropdown appears on the screen in relation to the element that activates it.

Allowed Values

• "auto" - The position is automatically determines by measuring the available distance around the element for the drop down to open freely without being clipped by the edges of the browser. By default the drop down will try to open below the element. If the available space is not enough for the popup to appear it will open in one of the following directions, if possible: top, over.
• "top" - The drop down opens above the element.
• "bottom" - The drop down opens under the element.
• "overlay-top" - The drop down opens above and over the element. The bottom edges of the drop down cover the element.
• "overlay-center" - The drop down opens at the center, over the element.
• "overlay-bottom" - The drop down opens under and over the element. The top edges of the drop down cover the element.
• "center-bottom" - The drop down opens at the center, below the element.
• "center-top" - The drop down opens at the center, over the element.

<ComboBox dropDownPosition="top" />

comboboxRef.current!.dropDownPosition = "bottom";

const dropDownPosition = comboboxRef.current!.dropDownPosition;

dropDownWidthSpecifies the width of the dropdown menu. By default, this property is set to an empty string, allowing the dropdown's width to be determined by the associated CSS variable (typically via custom properties or theme settings). If a value is provided, it overrides the CSS variable and directly sets the dropdown's width.string | number

Specifies the width of the dropdown menu. By default, this property is set to an empty string, allowing the dropdown's width to be determined by the associated CSS variable (typically via custom properties or theme settings). If a value is provided, it overrides the CSS variable and directly sets the dropdown's width.

<ComboBox dropDownWidth="auto" />

comboboxRef.current!.dropDownWidth = 500;

const dropDownWidth = comboboxRef.current!.dropDownWidth;

escKeyModeSpecifies how the element should respond when the Escape key is pressed by the user. This property allows you to define actions such as closing a modal, dismissing a dialog, or triggering a custom event when the Escape key is detected while the element is focused or active."none" | "previousValue" | "clearValue"

Specifies how the element should respond when the Escape key is pressed by the user. This property allows you to define actions such as closing a modal, dismissing a dialog, or triggering a custom event when the Escape key is detected while the element is focused or active.

Allowed Values

• "none" - Nothing happens on escape key.
• "previousValue" - The previous value is displayed.
• "clearValue" - The value is cleared.

<ComboBox escKeyMode="contains" />

comboboxRef.current!.escKeyMode = "equals";

const escKeyMode = comboboxRef.current!.escKeyMode;

filterableSpecifies whether the filtering feature is active. When set to true, users can apply filters to narrow down displayed data; when false, filtering options are disabled and all data is shown without restriction.boolean

Specifies whether the filtering feature is active. When set to true, users can apply filters to narrow down displayed data; when false, filtering options are disabled and all data is shown without restriction.

<ComboBox filterable={true} />

comboboxRef.current!.filterable = false;

const filterable = comboboxRef.current!.filterable;

filterInputPlaceholderSpecifies the placeholder text displayed inside the dropdown list’s filter input field, guiding users on what to enter when searching or filtering options.string

Specifies the placeholder text displayed inside the dropdown list’s filter input field, guiding users on what to enter when searching or filtering options.

<ComboBox filterInputPlaceholder="Enter a value:" />

comboboxRef.current!.filterInputPlaceholder = "Awaiting entry:";

const filterInputPlaceholder = comboboxRef.current!.filterInputPlaceholder;

filterModeSpecifies the filtering behavior for the Combo Box, controlling how user input is matched against the available options (e.g., contains, starts with, or exact match). This property determines which options are displayed in the dropdown list as the user types."contains" | "containsIgnoreCase" | "custom" | "doesNotContain" | "doesNotContainIgnoreCase" | "equals" | "equalsIgnoreCase" | "startsWith" | "startsWithIgnoreCase" | "endsWith" | "endsWithIgnoreCase"

Specifies the filtering behavior for the Combo Box, controlling how user input is matched against the available options (e.g., contains, starts with, or exact match). This property determines which options are displayed in the dropdown list as the user types.

Allowed Values

• "contains" - displays only items with labels that contain the filter string (case sensitive)
• "containsIgnoreCase" - displays only items with labels that contain the filter string (case insensitive)
• "custom" - filtering is applied according to the callback function filterCallback
• "doesNotContain" - displays only items with labels that do not contain the filter string (case sensitive)
• "doesNotContainIgnoreCase" - displays only items with labels that do not contain the filter string (case insensitive)
• "equals" - displays only items with labels that equal the filter string (case sensitive)
• "equalsIgnoreCase" - displays only items with labels that equal the filter string (case insensitive)
• "startsWith" - displays only items with labels that start with the filter string (case sensitive)
• "startsWithIgnoreCase" - displays only items with labels that start with the filter string (case insensitive)
• "endsWith" - displays only items with labels that end with the filter string (case sensitive)
• "endsWithIgnoreCase" - displays only items with labels that end with the filter string (case insensitive)

<ComboBox filterMode="contains" />

comboboxRef.current!.filterMode = "equals";

const filterMode = comboboxRef.current!.filterMode;

groupedWhen enabled, this option automatically groups the items based on the first letter of each item's value or label. Note: This grouping feature is only available if the dataSource does not already include predefined groups. If the dataSource is already grouped, this setting will have no effect.boolean

When enabled, this option automatically groups the items based on the first letter of each item's value or label. Note: This grouping feature is only available if the dataSource does not already include predefined groups. If the dataSource is already grouped, this setting will have no effect.

<ComboBox grouped={true} />

comboboxRef.current!.grouped = false;

const grouped = comboboxRef.current!.grouped;

groupMemberSpecifies which attribute of the dataSource object should be used to group items in the ListBox. By default, if this property (groupMember) is not set, the ListBox will use the 'group' property from each dataSource item to organize groups. This property is particularly useful when loading data from a JSON file, allowing you to designate a specific property from your data objects to determine the grouping of items—especially if your JSON structure uses a different property name for grouping.string

Specifies which attribute of the dataSource object should be used to group items in the ListBox. By default, if this property (groupMember) is not set, the ListBox will use the 'group' property from each dataSource item to organize groups. This property is particularly useful when loading data from a JSON file, allowing you to designate a specific property from your data objects to determine the grouping of items—especially if your JSON structure uses a different property name for grouping.

<ComboBox groupMember="group" />

comboboxRef.current!.groupMember = "section";

const groupMember = comboboxRef.current!.groupMember;

hintDisplays supplementary helper text beneath the element. This hint is visible exclusively when the element is in focus, providing contextual guidance to users as they interact with the field.string

Displays supplementary helper text beneath the element. This hint is visible exclusively when the element is in focus, providing contextual guidance to users as they interact with the field.

<ComboBox hint="Helper text" />

comboboxRef.current!.hint = "Hint";

const hint = comboboxRef.current!.hint;

horizontalScrollBarVisibilityControls whether the horizontal scroll bar is displayed within the dropdown menu when the content exceeds the available width."auto" | "disabled" | "hidden" | "visible"

Controls whether the horizontal scroll bar is displayed within the dropdown menu when the content exceeds the available width.

Allowed Values

• "auto" - The element automatically determines whether or not the horizontal Scroll bar should be visible or not.
• "disabled" - Disables the horizontal Scroll bar.
• "hidden" - Hides the horizontal Scroll bar.
• "visible" - Shows the horizontal Scroll bar even if not necessary.

<ComboBox horizontalScrollBarVisibility="disabled" />

comboboxRef.current!.horizontalScrollBarVisibility = "hidden";

const horizontalScrollBarVisibility = comboboxRef.current!.horizontalScrollBarVisibility;

incrementalSearchDelayThe 'IncrementalSearchDelay' property defines the duration, in milliseconds, to wait after the user stops typing before clearing the previous search query. This timer begins as soon as the user finishes typing. During this delay period, no new search query will be initiated. Only after the specified delay has elapsed will the current search input be cleared, allowing a new search query to be started. This helps to optimize performance and user experience by preventing unnecessary or premature queries while the user is still entering their search terms.number

The 'IncrementalSearchDelay' property defines the duration, in milliseconds, to wait after the user stops typing before clearing the previous search query. This timer begins as soon as the user finishes typing. During this delay period, no new search query will be initiated. Only after the specified delay has elapsed will the current search input be cleared, allowing a new search query to be started. This helps to optimize performance and user experience by preventing unnecessary or premature queries while the user is still entering their search terms.

<ComboBox incrementalSearchDelay={100} />

comboboxRef.current!.incrementalSearchDelay = 500;

const incrementalSearchDelay = comboboxRef.current!.incrementalSearchDelay;

incrementalSearchModeConfigures or retrieves the current mode of incremental search. By default, incremental search is enabled, allowing users to type while the dropdown is focused to quickly filter and highlight matching options. Modifying this setting controls how user input is processed for searching within the dropdown list."contains" | "containsIgnoreCase" | "doesNotContain" | "doesNotContainIgnoreCase" | "equals" | "equalsIgnoreCase" | "startsWith" | "startsWithIgnoreCase" | "endsWith" | "endsWithIgnoreCase"

Configures or retrieves the current mode of incremental search. By default, incremental search is enabled, allowing users to type while the dropdown is focused to quickly filter and highlight matching options. Modifying this setting controls how user input is processed for searching within the dropdown list.

Allowed Values

• "contains" - focuses the item that contains the search query ( case sensitive)
• "containsIgnoreCase" - focuses the item that contains the search query (case insensitive)
• "doesNotContain" - focuses the item that does not contain the search query (case sensitive)
• "doesNotContainIgnoreCase" - focuses the item that does not contain the search query (case insensitive)
• "equals" - focuses the item that is equal the search query (case sensitive)
• "equalsIgnoreCase" - focuses the item that is equal the search query (case insensitive)
• "startsWith" - focuses the item that starts with the search query (case sensitive)
• "startsWithIgnoreCase" - focuses the item that starts with the search query (case insensitive)
• "endsWith" - focuses the item that ends with the search query (case sensitive)
• "endsWithIgnoreCase" - focuses the item that starts with the search query (case insensitive)

<ComboBox incrementalSearchMode="contains" />

comboboxRef.current!.incrementalSearchMode = "endsWith";

const incrementalSearchMode = comboboxRef.current!.incrementalSearchMode;

inputMemberRepresents the property name of a List item whose value will be displayed in the input field when a ListItem is selected. This allows developers to control which property of each item is shown in the input, such as displaying the item's value instead of its label. By default, the label property is used for display. This option is useful when you want to customize the displayed content, for example, to show a unique identifier or value rather than the descriptive label.string

Represents the property name of a List item whose value will be displayed in the input field when a ListItem is selected. This allows developers to control which property of each item is shown in the input, such as displaying the item's value instead of its label. By default, the label property is used for display. This option is useful when you want to customize the displayed content, for example, to show a unique identifier or value rather than the descriptive label.

<ComboBox inputMember="label" />

comboboxRef.current!.inputMember = "value";

const inputMember = comboboxRef.current!.inputMember;

inputPurposeSpecifies the expected type of information for the input field and informs the browser about the nature of the data to be entered. This guidance allows user agents (such as browsers and password managers) to determine if they can provide automated assistance—like autofilling relevant values—when the element is used in a form. The value assigned to this property directly maps to the standard HTML autocomplete attribute. Common values include 'on' (enable autocomplete), 'off' (disable autocomplete), 'name' (full name), 'organization' (company or organization), 'email', 'street-address', and many others, as specified by the HTML standard. Using an appropriate value improves user experience, enhances accessibility, and helps maintain privacy and security standards within web forms.string

Specifies the expected type of information for the input field and informs the browser about the nature of the data to be entered. This guidance allows user agents (such as browsers and password managers) to determine if they can provide automated assistance—like autofilling relevant values—when the element is used in a form. The value assigned to this property directly maps to the standard HTML autocomplete attribute. Common values include 'on' (enable autocomplete), 'off' (disable autocomplete), 'name' (full name), 'organization' (company or organization), 'email', 'street-address', and many others, as specified by the HTML standard. Using an appropriate value improves user experience, enhances accessibility, and helps maintain privacy and security standards within web forms.

<ComboBox inputPurpose="on" />

comboboxRef.current!.inputPurpose = "country";

const inputPurpose = comboboxRef.current!.inputPurpose;

itemHeightSpecifies the height (in pixels) for each list item when rendering the list. This property is only applicable when list virtualization is enabled, as it helps optimize rendering performance by allowing the component to calculate and render only the visible items.number

Specifies the height (in pixels) for each list item when rendering the list. This property is only applicable when list virtualization is enabled, as it helps optimize rendering performance by allowing the component to calculate and render only the visible items.

<ComboBox itemHeight={20} />

comboboxRef.current!.itemHeight = 30;

const itemHeight = comboboxRef.current!.itemHeight;

itemMeasureModeSpecifies the algorithm used to calculate the width of each item. This setting determines how the width of an item is measured, such as using the item's intrinsic content size, a fixed value, or a percentage of the container. Adjust this parameter to control how item widths are determined within the layout."auto" | "precise"

Specifies the algorithm used to calculate the width of each item. This setting determines how the width of an item is measured, such as using the item's intrinsic content size, a fixed value, or a percentage of the container. Adjust this parameter to control how item widths are determined within the layout.

Allowed Values

• "auto" - measures items based on the number of characters in their label
• "precise" - measures items based on their actual size in the DOM; may hinder performance for large data sources

<ComboBox itemMeasureMode="precise" />

comboboxRef.current!.itemMeasureMode = "auto";

const itemMeasureMode = comboboxRef.current!.itemMeasureMode;

itemsA getter method that retrieves and returns an array containing all list ('li') elements currently present within the dropdown menu. This allows you to easily access and manipulate every item displayed in the dropdown.{label: string, value: string}[]

A getter method that retrieves and returns an array containing all list ('li') elements currently present within the dropdown menu. This allows you to easily access and manipulate every item displayed in the dropdown.

itemTemplateThe itemTemplate property is a string that specifies the ID of an HTMLTemplateElement present in the DOM. This template is used to define and customize the structure and content of individual list items, allowing developers to control how each item appears when rendered in the list.any

The itemTemplate property is a string that specifies the ID of an HTMLTemplateElement present in the DOM. This template is used to define and customize the structure and content of individual list items, allowing developers to control how each item appears when rendered in the list.

<ComboBox itemTemplate="'templateA'" />

comboboxRef.current!.itemTemplate = "'templateB'";

const itemTemplate = comboboxRef.current!.itemTemplate;

labelDisplays a small text label positioned above the element, typically used to provide context, instructions, or additional information to users.string

Displays a small text label positioned above the element, typically used to provide context, instructions, or additional information to users.

<ComboBox label="Helper text" />

comboboxRef.current!.label = "Label";

const label = comboboxRef.current!.label;

loadingIndicatorPlaceholderSpecifies the text that appears alongside the loading indicator when the loader is visible and positioned at the top or bottom of the component. This text provides users with contextual information or status updates during loading.string

Specifies the text that appears alongside the loading indicator when the loader is visible and positioned at the top or bottom of the component. This text provides users with contextual information or status updates during loading.

<ComboBox loadingIndicatorPlaceholder="Incoming data" />

comboboxRef.current!.loadingIndicatorPlaceholder = "LOADING...";

const loadingIndicatorPlaceholder = comboboxRef.current!.loadingIndicatorPlaceholder;

loadingIndicatorPositionSpecifies the exact location on the user interface where the loading indicator will be displayed, such as at the top, center, or bottom of the screen or component."bottom" | "center" | "top"

Specifies the exact location on the user interface where the loading indicator will be displayed, such as at the top, center, or bottom of the screen or component.

Allowed Values

• "bottom" - Positions the loading indicator at the bottom of the list.
• "center" - Positions the loading indicator at the center of the list.
• "top" - Positions the loading indicator at the bottom of the list.

<ComboBox loadingIndicatorPosition="bottom" />

comboboxRef.current!.loadingIndicatorPosition = "top";

const loadingIndicatorPosition = comboboxRef.current!.loadingIndicatorPosition;

localeSpecifies or retrieves the current language setting for the component. This property determines which language is used when displaying content from the messages property, allowing for localization and internationalization of displayed messages. Set this property to a supported language code (e.g., "en", "fr") to load the corresponding translations from the messages object.string

Specifies or retrieves the current language setting for the component. This property determines which language is used when displaying content from the messages property, allowing for localization and internationalization of displayed messages. Set this property to a supported language code (e.g., "en", "fr") to load the corresponding translations from the messages object.

<ComboBox locale="de" />

comboboxRef.current!.locale = "en";

const locale = comboboxRef.current!.locale;

localizeFormatFunctionA callback function that allows you to customize the formatting of messages returned by the Localization Module. Use this callback to modify message text, apply dynamic values, or implement custom formatting logic before the localized messages are delivered to your application.function | null

A callback function that allows you to customize the formatting of messages returned by the Localization Module. Use this callback to modify message text, apply dynamic values, or implement custom formatting logic before the localized messages are delivered to your application.

<ComboBox localizeFormatFunction="function(defaultMessage, message, messageArguments){return '...'}" />

comboboxRef.current!.localizeFormatFunction = "function(defaultMessage, message, messageArguments){return '...'}";

const localizeFormatFunction = comboboxRef.current!.localizeFormatFunction;

maxLengthSpecifies the maximum number of characters that can be entered into the input field. Any additional characters beyond this limit will not be accepted. This helps enforce data validation and consistency for user input.number

Specifies the maximum number of characters that can be entered into the input field. Any additional characters beyond this limit will not be accepted. This helps enforce data validation and consistency for user input.

<ComboBox maxLength={3} />

comboboxRef.current!.maxLength = 4;

const maxLength = comboboxRef.current!.maxLength;

messagesSpecifies or retrieves an object containing localized string values used within the widget’s user interface. This property enables the customization and translation of UI text for different languages or regions. It is intended to be used together with the locale property, allowing you to easily provide or update localized strings according to the selected locale.object

Specifies or retrieves an object containing localized string values used within the widget’s user interface. This property enables the customization and translation of UI text for different languages or regions. It is intended to be used together with the locale property, allowing you to easily provide or update localized strings according to the selected locale.

<ComboBox messages="{"de":{"propertyUnknownType":"Die Eigenschaft '{{name}}' hat ein nicht definiertes 'type'-Member!","propertyInvalidValue":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualValue}}, Erwarteter Wert: {{value}}!","propertyInvalidValueType":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualType}}, Erwarteter Wert: {{type}}!","elementNotInDOM":"Element existiert nicht in DOM! Bitte fugen Sie das Element zum DOM hinzu, bevor Sie eine Methode aufrufen.","moduleUndefined":"Modul ist nicht definiert.","missingReference":"{{elementType}}: Fehlender Verweis auf {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser unterstutzt keine HTMLTemplate-Elemente.","invalidTemplate":"{{elementType}}: '{{property}}' Die Eigenschaft akzeptiert eine Zeichenfolge, die mit der ID eines HTMLTemplate-Elements aus dem DOM ubereinstimmen muss.","invalidNode":"{{elementType}}: Ungultiger Parameter '{{node}}' beim Aufruf von {{method}}."}}" />

comboboxRef.current!.messages = {"en":{"propertyUnknownType":"'{{name}}' property is with undefined 'type' member!","propertyInvalidValue":"Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!","propertyInvalidValueType":"Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!","elementNotInDOM":"Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.","moduleUndefined":"Module is undefined.","missingReference":"{{elementType}}: Missing reference to {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser doesn't support HTMLTemplate elements.","invalidTemplate":"{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.","invalidNode":"{{elementType}}: Invalid parameter '{{node}}' when calling {{method}}."}};

const messages = comboboxRef.current!.messages;

minLengthSpecifies the minimum number of characters a user must enter in the input field before the autocomplete feature is activated and suggestions are displayed.number

Specifies the minimum number of characters a user must enter in the input field before the autocomplete feature is activated and suggestions are displayed.

<ComboBox minLength={3} />

comboboxRef.current!.minLength = 4;

const minLength = comboboxRef.current!.minLength;

nameSets or retrieves the value of the element's name attribute. The name attribute uniquely identifies form elements when submitting HTML forms, allowing the form data to be organized and accessed by name on the server side. This attribute is essential for grouping form controls and accurately transmitting user input during form submission.string

Sets or retrieves the value of the element's name attribute. The name attribute uniquely identifies form elements when submitting HTML forms, allowing the form data to be organized and accessed by name on the server side. This attribute is essential for grouping form controls and accurately transmitting user input during form submission.

<ComboBox name="combobox" />

comboboxRef.current!.name = "comboBox2";

const name = comboboxRef.current!.name;

openedSpecifies whether the popup is currently visible (open) or hidden (closed) in the user interface.boolean

Specifies whether the popup is currently visible (open) or hidden (closed) in the user interface.

<ComboBox opened={true} />

comboboxRef.current!.opened = false;

const opened = comboboxRef.current!.opened;

placeholderSpecifies the placeholder text that appears inside the input field when it is empty, providing guidance or example content to the user.string

Specifies the placeholder text that appears inside the input field when it is empty, providing guidance or example content to the user.

<ComboBox placeholder="Choose:" />

comboboxRef.current!.placeholder = "Submit";

const placeholder = comboboxRef.current!.placeholder;

readonlyPrevents any user interactions with the element, including clicking, tapping, selecting, hovering, or focusing. While this is enabled, the element will not respond to mouse, keyboard, or touch events, effectively making it non-interactive for users.boolean

Prevents any user interactions with the element, including clicking, tapping, selecting, hovering, or focusing. While this is enabled, the element will not respond to mouse, keyboard, or touch events, effectively making it non-interactive for users.

<ComboBox readonly={true} />

comboboxRef.current!.readonly = false;

const readonly = comboboxRef.current!.readonly;

resizeIndicatorControls the visibility of the resize indicator located in the bottom-right corner of the dropdown component. When this property is set to true, users will see a handle allowing them to resize the dropdown area. This property should be used together with the resizeMode property to define both the availability and behavior of the resizing feature.boolean

Controls the visibility of the resize indicator located in the bottom-right corner of the dropdown component. When this property is set to true, users will see a handle allowing them to resize the dropdown area. This property should be used together with the resizeMode property to define both the availability and behavior of the resizing feature.

<ComboBox resizeIndicator={true} />

comboboxRef.current!.resizeIndicator = false;

const resizeIndicator = comboboxRef.current!.resizeIndicator;

resizeModeSpecifies whether the drop-down menu is resizable by the user. If resizing is enabled, a resize bar will be displayed along the top or bottom edge of the drop-down, allowing users to click and drag to adjust its height. Disabling this option removes the resize bar and prevents any manual resizing of the drop-down component."none" | "horizontal" | "vertical" | "both"

Specifies whether the drop-down menu is resizable by the user. If resizing is enabled, a resize bar will be displayed along the top or bottom edge of the drop-down, allowing users to click and drag to adjust its height. Disabling this option removes the resize bar and prevents any manual resizing of the drop-down component.

Allowed Values

• "none" - Resizing the drop down is not allowed.
• "horizontal" - Horizontal resizing of the drop down is allowed but not vertical.
• "vertical" - Vertical resizing of the drop down is allowed but not horizontal.
• "both" - Resizing the drop down is allowed in all directions.

<ComboBox resizeMode="horizontal" />

comboboxRef.current!.resizeMode = "vertical";

const resizeMode = comboboxRef.current!.resizeMode;

rightToLeftSpecifies or retrieves a value that determines whether the element’s text direction is set to support right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element and its content are aligned according to RTL formatting, ensuring proper display for locales that use right-to-left scripts.boolean

Specifies or retrieves a value that determines whether the element’s text direction is set to support right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element and its content are aligned according to RTL formatting, ensuring proper display for locales that use right-to-left scripts.

<ComboBox rightToLeft={true} />

comboboxRef.current!.rightToLeft = true;

const rightToLeft = comboboxRef.current!.rightToLeft;

selectedIndexesSets or retrieves the selected indexes. The selected indexes property is an array containing the numeric indexes of the items that are currently selected. Each value in the array corresponds to the position of a selected item within the overall list or collection. Assigning a new array to this property updates the selection state to match the specified indexes; retrieving it returns the current selection as an array of indexes. number[]

Sets or retrieves the selected indexes. The selected indexes property is an array containing the numeric indexes of the items that are currently selected. Each value in the array corresponds to the position of a selected item within the overall list or collection. Assigning a new array to this property updates the selection state to match the specified indexes; retrieving it returns the current selection as an array of indexes.

<ComboBox selectedIndexes="[1,2,3]" />

comboboxRef.current!.selectedIndexes = [4,5,6];

const selectedIndexes = comboboxRef.current!.selectedIndexes;

selectedValues "Sets or retrieves the currently selected indexes. The 'selected' property holds an array of the indices corresponding to the items that are marked as selected. When setting this property, provide an array of indexes to specify which items should be selected. When getting this property, it returns the array of indexes for the currently selected items." string[]

"Sets or retrieves the currently selected indexes. The 'selected' property holds an array of the indices corresponding to the items that are marked as selected. When setting this property, provide an array of indexes to specify which items should be selected. When getting this property, it returns the array of indexes for the currently selected items."

<ComboBox selectedValues="["item 1"]" />

comboboxRef.current!.selectedValues = ["item 2"];

const selectedValues = comboboxRef.current!.selectedValues;

selectionDisplayModeSpecifies the content or value that will appear within the input field, either as a default value, user-entered data, or dynamically generated content. This setting controls what the user sees and interacts with inside the input element."plain" | "placeholder" | "tokens"

Specifies the content or value that will appear within the input field, either as a default value, user-entered data, or dynamically generated content. This setting controls what the user sees and interacts with inside the input element.

Allowed Values

• "plain" - Default behavior. The selected item's label appears in the input of the element.
• "placeholder" - The placeholder of the input is always shown regardless of the current selection.
• "tokens" - Token items are being appended to input field for each selected item. Tokens are used for multiple selection modes. When a token's label is clicked the drop down opens and the corresponding item will be focused.

<ComboBox selectionDisplayMode="placeholder" />

comboboxRef.current!.selectionDisplayMode = "default";

const selectionDisplayMode = comboboxRef.current!.selectionDisplayMode;

selectionModeSpecifies the maximum number of items that a user is allowed to select at one time. If this value is set to 1, only single selection is permitted; higher values allow multiple selections up to the defined limit."none" | "oneOrManyExtended" | "zeroOrMany" | "oneOrMany" | "zeroAndOne" | "zeroOrOne" | "one" | "checkBox" | "radioButton"

Specifies the maximum number of items that a user is allowed to select at one time. If this value is set to 1, only single selection is permitted; higher values allow multiple selections up to the defined limit.

Allowed Values

• "none" - Item selection is not allowed.
• "oneOrManyExtended" - Only one item can be selected unless when pressing the Shift or Control keys of the keyboard more then one item can be selected. Shift key allows to select a range of items while Control allows to select/unselect speciic items. There is always at least one selected item
• "zeroOrMany" - Zero or many items can be selected.
• "oneOrMany" - One or more items must be selected. There is always at least one selected item
• "zeroAndOne" - Only one item can optionally be selected.
• "zeroOrOne" - Zero or one item can be selected.
• "one" - Only one item can be selected. There is always at least one selected item
• "checkBox" - A Check box appears next to every List item inside the drop down. One, many or zero items can be selected.
• "radioButton" - A radio button appears next to every List item inside the drop down. Only one item can be selected or one item per group if grouped is enabled.

<ComboBox selectionMode="zeroOrMany" />

comboboxRef.current!.selectionMode = "oneOrMany";

const selectionMode = comboboxRef.current!.selectionMode;

sortDirectionSpecifies the sorting order for data, allowing you to choose between ascending ("asc") for lowest-to-highest or alphabetical A–Z sorting, and descending ("desc") for highest-to-lowest or Z–A sorting.string

Specifies the sorting order for data, allowing you to choose between ascending ("asc") for lowest-to-highest or alphabetical A–Z sorting, and descending ("desc") for highest-to-lowest or Z–A sorting.

<ComboBox sortDirection="desc" />

comboboxRef.current!.sortDirection = "asc";

const sortDirection = comboboxRef.current!.sortDirection;

sortedSpecifies whether the items are arranged in alphabetical order. If set to true, the items will be sorted alphabetically; if false, the original order will be preserved.boolean

Specifies whether the items are arranged in alphabetical order. If set to true, the items will be sorted alphabetically; if false, the original order will be preserved.

<ComboBox sorted={true} />

comboboxRef.current!.sorted = false;

const sorted = comboboxRef.current!.sorted;

themeSpecifies the visual theme to be applied to the element. The selected theme controls the element’s appearance, including colors, fonts, and other stylistic properties, ensuring a consistent look and feel across the user interface.string

Specifies the visual theme to be applied to the element. The selected theme controls the element’s appearance, including colors, fonts, and other stylistic properties, ensuring a consistent look and feel across the user interface.

<ComboBox theme="blue" />

comboboxRef.current!.theme = "red";

const theme = comboboxRef.current!.theme;

tokenTemplateDefines the custom content to display within each token when the selectionDisplayMode is set to "tokens". Tokens visually represent selected items in a multi-select interface and are only applicable when multiple selection is enabled. Use this option to customize how each token appears, such as displaying specific text, icons, or additional data for each selected item.any

Defines the custom content to display within each token when the selectionDisplayMode is set to "tokens". Tokens visually represent selected items in a multi-select interface and are only applicable when multiple selection is enabled. Use this option to customize how each token appears, such as displaying specific text, icons, or additional data for each selected item.

<ComboBox tokenTemplate="tokenTemplate" />

comboboxRef.current!.tokenTemplate = null;

const tokenTemplate = comboboxRef.current!.tokenTemplate;

unfocusableIf set to true, the element will not be able to receive keyboard or mouse focus, making it inaccessible via tab navigation or programmatic focus methods.boolean

If set to true, the element will not be able to receive keyboard or mouse focus, making it inaccessible via tab navigation or programmatic focus methods.

<ComboBox unfocusable={true} />

comboboxRef.current!.unfocusable = false;

const unfocusable = comboboxRef.current!.unfocusable;

unlockKeySets or retrieves the unlockKey, a unique value required to grant access to the product’s premium features or activate its full functionality.string

Sets or retrieves the unlockKey, a unique value required to grant access to the product’s premium features or activate its full functionality.

<ComboBox unlockKey="" />

comboboxRef.current!.unlockKey = "1111-2222-3333-4444-5555";

const unlockKey = comboboxRef.current!.unlockKey;

valueProvides functionality to retrieve (get) or assign (set) the current value of the property. When used as a getter, it returns the property's current value. When used as a setter, it updates the property with the specified value.string

Provides functionality to retrieve (get) or assign (set) the current value of the property. When used as a getter, it returns the property's current value. When used as a setter, it updates the property with the specified value.

<ComboBox value="val1" />

comboboxRef.current!.value = "val2";

const value = comboboxRef.current!.value;

valueMemberSpecifies which property of each item object should be used as the value for that item. The value designated by valueMember will be stored in the item's value field. This property functions similarly to groupMember, but is focused on identifying the value rather than the group. valueMember is particularly useful when populating a ListBox from a JSON data source, as it allows you to specify which property of your data objects should serve as the unique value for each item in the ListBox.string

Specifies which property of each item object should be used as the value for that item. The value designated by valueMember will be stored in the item's value field. This property functions similarly to groupMember, but is focused on identifying the value rather than the group. valueMember is particularly useful when populating a ListBox from a JSON data source, as it allows you to specify which property of your data objects should serve as the unique value for each item in the ListBox.

<ComboBox valueMember="value" />

comboboxRef.current!.valueMember = "newValue";

const valueMember = comboboxRef.current!.valueMember;

verticalScrollBarVisibilityControls whether the vertical scroll bar is displayed within the content area, allowing users to scroll vertically when the content extends beyond the visible region."auto" | "disabled" | "hidden" | "visible"

Controls whether the vertical scroll bar is displayed within the content area, allowing users to scroll vertically when the content extends beyond the visible region.

Allowed Values

• "auto" - The element automatically determines whether or not the horizontal scroll bar should be visible or not.
• "disabled" - Disables the horizontal scroll bar.
• "hidden" - Hides the horizontal scroll bar.
• "visible" - Shows the horizontal scroll bar even if not necessary.

<ComboBox verticalScrollBarVisibility="hidden" />

comboboxRef.current!.verticalScrollBarVisibility = "visible";

const verticalScrollBarVisibility = comboboxRef.current!.verticalScrollBarVisibility;

virtualizedDetermines whether virtualization is enabled for the ComboBox. When virtualization is enabled, the ComboBox can efficiently display a very large number of items—such as a million—by only rendering the visible items in the ListBox and dynamically loading items as needed. This significantly improves performance and reduces memory usage, especially with large data sets.boolean

Determines whether virtualization is enabled for the ComboBox. When virtualization is enabled, the ComboBox can efficiently display a very large number of items—such as a million—by only rendering the visible items in the ListBox and dynamically loading items as needed. This significantly improves performance and reduces memory usage, especially with large data sets.

<ComboBox virtualized={true} />

comboboxRef.current!.virtualized = false;

const virtualized = comboboxRef.current!.virtualized;

Events

onChangeThis event is triggered whenever the user changes the current selection, such as highlighting different text or selecting a new item in a list. It allows you to detect and respond to updates in the selected content or options within the interface.CustomEvent

This event is triggered whenever the user changes the current selection, such as highlighting different text or selecting a new item in a list. It allows you to detect and respond to updates in the selected content or options within the interface.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onChange

Arguments

<ComboBox onChange={handleChange} />

function handleChange(event: CustomEvent) {
  const detail = event.detail,
    addedItems = detail.addedItems,
    disabled = detail.disabled,
    index = detail.index,
    label = detail.label,
    removedItems = detail.removedItems,
    selected = detail.selected,
    value = detail.value;

  // handle event …
}

onCloseThis event is triggered when the drop-down list is closed, either by the user selecting an option or by clicking outside the menu. It occurs after the drop-down menu is no longer visible, allowing you to perform actions in response to the menu's closure.CustomEvent

This event is triggered when the drop-down list is closed, either by the user selecting an option or by clicking outside the menu. It occurs after the drop-down menu is no longer visible, allowing you to perform actions in response to the menu's closure.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onClose

Arguments

<ComboBox onClose={handleClose} />

function handleClose(event: CustomEvent) {
  // handle event …
}

onClosingThis event is triggered right before the dropdown list is about to close, providing an opportunity to intervene. By calling event.preventDefault() within the event handler, you can cancel the closing operation, allowing you to perform validation, display a confirmation dialog, or execute custom logic before the dropdown is closed.CustomEvent

This event is triggered right before the dropdown list is about to close, providing an opportunity to intervene. By calling event.preventDefault() within the event handler, you can cancel the closing operation, allowing you to perform validation, display a confirmation dialog, or execute custom logic before the dropdown is closed.

• Bubbles Yes
• Cancelable Yes
• Interface CustomEvent
• Event handler property onClosing

Arguments

<ComboBox onClosing={handleClosing} />

function handleClosing(event: CustomEvent) {
  // handle event …
}

onItemClickThis event is triggered whenever a user clicks on a specific item, allowing you to execute custom actions in response to the user's selection. The event provides context about the clicked item, enabling you to access its properties or perform related updates within your application.CustomEvent

This event is triggered whenever a user clicks on a specific item, allowing you to execute custom actions in response to the user's selection. The event provides context about the clicked item, enabling you to access its properties or perform related updates within your application.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onItemClick

Arguments

<ComboBox onItemClick={handleItemClick} />

function handleItemClick(event: CustomEvent) {
  const detail = event.detail,
    disabled = detail.disabled,
    index = detail.index,
    label = detail.label,
    selected = detail.selected,
    value = detail.value;

  // handle event …
}

onOpenThis event is triggered whenever the dropdown list becomes visible to the user, such as when the user clicks or interacts with the control to expand and display the list of available options. Use this event to execute custom logic when the dropdown menu is opened.CustomEvent

This event is triggered whenever the dropdown list becomes visible to the user, such as when the user clicks or interacts with the control to expand and display the list of available options. Use this event to execute custom logic when the dropdown menu is opened.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onOpen

Arguments

<ComboBox onOpen={handleOpen} />

function handleOpen(event: CustomEvent) {
  // handle event …
}

onOpeningThis event is triggered immediately before the dropdown list is displayed to the user. Within the event handler, you can prevent the dropdown from opening by calling event.preventDefault(). This allows you to implement custom logic to conditionally allow or block the opening of the dropdown, such as validating conditions or managing user permissions before the list is shown.CustomEvent

This event is triggered immediately before the dropdown list is displayed to the user. Within the event handler, you can prevent the dropdown from opening by calling event.preventDefault(). This allows you to implement custom logic to conditionally allow or block the opening of the dropdown, such as validating conditions or managing user permissions before the list is shown.

• Bubbles Yes
• Cancelable Yes
• Interface CustomEvent
• Event handler property onOpening

Arguments

<ComboBox onOpening={handleOpening} />

function handleOpening(event: CustomEvent) {
  // handle event …
}

onResizeEndThis event is triggered after the user has completed resizing the dropdown menu, signaling that the resizing action has ended and the new dimensions have been set.CustomEvent

This event is triggered after the user has completed resizing the dropdown menu, signaling that the resizing action has ended and the new dimensions have been set.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onResizeEnd

Arguments

<ComboBox onResizeEnd={handleResizeEnd} />

function handleResizeEnd(event: CustomEvent) {
  const detail = event.detail,
    position = detail.position;

  // handle event …
}

onResizeStartThis event is triggered when the user initiates the resizing action on the dropdown component, such as clicking and dragging a resize handle. It allows developers to detect the exact moment when a resize operation on the dropdown begins.CustomEvent

This event is triggered when the user initiates the resizing action on the dropdown component, such as clicking and dragging a resize handle. It allows developers to detect the exact moment when a resize operation on the dropdown begins.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onResizeStart

Arguments

<ComboBox onResizeStart={handleResizeStart} />

function handleResizeStart(event: CustomEvent) {
  const detail = event.detail,
    position = detail.position;

  // handle event …
}

onScrollBottomReachedThis event is triggered when the user scrolls to the bottom of the dropdown list, indicating that all available options have been displayed. It can be used to detect when additional data should be loaded or when no further options remain in the dropdown.CustomEvent

This event is triggered when the user scrolls to the bottom of the dropdown list, indicating that all available options have been displayed. It can be used to detect when additional data should be loaded or when no further options remain in the dropdown.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onScrollBottomReached

Arguments

<ComboBox onScrollBottomReached={handleScrollBottomReached} />

function handleScrollBottomReached(event: CustomEvent) {
  // handle event …
}

onScrollTopReachedThis event is triggered when the user scrolls to the very beginning (top) of the dropdown list, indicating that no more items are available above the current view.CustomEvent

This event is triggered when the user scrolls to the very beginning (top) of the dropdown list, indicating that no more items are available above the current view.

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onScrollTopReached

Arguments

<ComboBox onScrollTopReached={handleScrollTopReached} />

function handleScrollTopReached(event: CustomEvent) {
  // handle event …
}

onTokenClickThis event is triggered when a token item (also known as a 'pill') is clicked by the user. By handling this event, developers have the opportunity to intercept the default action that would normally occur when the token is clicked—such as opening a dropdown or performing another related operation. To prevent the default behavior from executing, call event.preventDefault() within your event handler function."CustomEvent

This event is triggered when a token item (also known as a 'pill') is clicked by the user. By handling this event, developers have the opportunity to intercept the default action that would normally occur when the token is clicked—such as opening a dropdown or performing another related operation. To prevent the default behavior from executing, call event.preventDefault() within your event handler function."

• Bubbles Yes
• Cancelable No
• Interface CustomEvent
• Event handler property onTokenClick

Arguments

<ComboBox onTokenClick={handleTokenClick} />

function handleTokenClick(event: CustomEvent) {
  // handle event …
}

Methods

add( item: any): voidCreates and appends one or more new items to the collection or list.

Creates and appends one or more new items to the collection or list.

Arguments

itemany

Describes the properties of the item that will be inserted. You can also pass an array of items.

comboboxRef.current?.add("'New item'");

appendChild( node: Node): TAppends a new ListItem element to the end of the existing list of items within the specified container element, thereby updating the list to include the newly added item as its last entry.

Arguments

nodeNode

A ListItem element that should be added to the rest of the items as the last item.

ReturnsNode

clearItems(): voidRemoves all existing items from the dropdown list, resulting in an empty list with no selectable options displayed to the user.

Removes all existing items from the dropdown list, resulting in an empty list with no selectable options displayed to the user.

comboboxRef.current?.clearItems();

clearSelection(): voidDeselects all currently selected items, ensuring that no items remain selected. This action clears any existing selections and resets the selection state.

Deselects all currently selected items, ensuring that no items remain selected. This action clears any existing selections and resets the selection state.

comboboxRef.current?.clearSelection();

close(): voidCloses the currently open drop-down list, hiding all available options from view and returning the component to its collapsed state. This action ensures that the drop-down menu is no longer visible to the user.

Closes the currently open drop-down list, hiding all available options from view and returning the component to its collapsed state. This action ensures that the drop-down menu is no longer visible to the user.

comboboxRef.current?.close();

dataBind(): voidInitiates a data binding process, connecting UI components to the underlying data source. This method refreshes the data source, ensuring that any changes made to the data are reflected in the user interface. It can be used to update displayed information after modifying, adding, or deleting data.

Initiates a data binding process, connecting UI components to the underlying data source. This method refreshes the data source, ensuring that any changes made to the data are reflected in the user interface. It can be used to update displayed information after modifying, adding, or deleting data.

comboboxRef.current?.dataBind();

ensureVisible( item: HTMLElement | string): voidScrolls the target item into view within its container, automatically adjusting the scroll position as needed to make sure the entire item is fully visible to the user.

Scrolls the target item into view within its container, automatically adjusting the scroll position as needed to make sure the entire item is fully visible to the user.

Arguments

itemHTMLElement | string

A list item or value of the desired item to be visible.

comboboxRef.current?.ensureVisible("'item1'");

getItem( value: string): HTMLElementReturns a specific item instance from the dropDown list, allowing you to access the properties and methods of the selected list item. This can be used to retrieve information about the item, such as its value, label, or index within the dropDown.

Returns a specific item instance from the dropDown list, allowing you to access the properties and methods of the selected list item. This can be used to retrieve information about the item, such as its value, label, or index within the dropDown.

Arguments

valuestring

The value of an item from the drop down list.

ReturnsHTMLElement

const result = comboboxRef.current?.getItem("First");

insert( position: number, item: any): voidInserts a new item into the array at the specified index position, shifting existing elements to the right to accommodate the new item.

Inserts a new item into the array at the specified index position, shifting existing elements to the right to accommodate the new item.

Arguments

positionnumber

The position where the item must be inserted.

itemany

Describes the properties of the item that will be inserted. You can also pass an array of items.

comboboxRef.current?.insert(5,"'New item'");

insertBefore( node: Node, referenceNode: Node | null): TInserts a new ListItem element directly before a specified existing ListItem within the list, preserving the order of the remaining items.

Arguments

nodeNode

A ListItem element that should be added before the referenceItem in the list.

referenceNodeNode | null

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.

ReturnsNode

open(): voidDisplays and expands the drop-down list, making all available options visible for selection.

Displays and expands the drop-down list, making all available options visible for selection.

comboboxRef.current?.open();

removeAt( position: number): voidRemoves the item located at the specified index or position within a collection (such as an array or list). After removal, the collection is updated so that subsequent items shift to fill the gap, ensuring contiguous indexing.

Removes the item located at the specified index or position within a collection (such as an array or list). After removal, the collection is updated so that subsequent items shift to fill the gap, ensuring contiguous indexing.

Arguments

positionnumber

The position of the removed item.

comboboxRef.current?.removeAt(5);

removeChild( node: Node): TRemoves a specified ListItem from the collection of items contained within the given element, updating the list to reflect the deletion.

Arguments

nodeNode

A ListItem element that is part of the list of items inside the element.

ReturnsNode

select( item: string | HTMLElement): voidSelects a specified item from the dropdown list, allowing users to choose one option from the available choices. This action updates the dropdown’s current selection and can trigger any associated event handlers or changes in the application’s state.

Selects a specified item from the dropdown list, allowing users to choose one option from the available choices. This action updates the dropdown’s current selection and can trigger any associated event handlers or changes in the application’s state.

Arguments

itemstring | HTMLElement

A string, representing the value of the item or an HTML Element referencing an item from the list

comboboxRef.current?.select("'First Item'");

unselect( item: string | HTMLElement): voidDeselects a specified item from the dropdown list, removing its selected state and reverting the dropdown to reflect that the item is no longer chosen by the user.

Deselects a specified item from the dropdown list, removing its selected state and reverting the dropdown to reflect that the item is no longer chosen by the user.

Arguments

itemstring | HTMLElement

A string, representing the value of the item or an HTML Element referencing an item from the list

comboboxRef.current?.unselect("'First Item'");

update( position: number, value: any): voidUpdates the selected item in the dropDown list with new data or attributes. This action modifies the existing item rather than adding or removing items from the list, ensuring that any changes are reflected immediately in the user interface. Specify the target item and the updated values to complete the operation.

Updates the selected item in the dropDown list with new data or attributes. This action modifies the existing item rather than adding or removing items from the list, ensuring that any changes are reflected immediately in the user interface. Specify the target item and the updated values to complete the operation.

Arguments

positionnumber

The position where the item must be updated.

valueany

The value of the updated item.

comboboxRef.current?.update(5,"'Updated item'");

CSS Variables

--smart-combo-box-default-widthvar()

smartComboBox default width

--smart-combo-box-default-heightvar()

smartComboBox default height

--smart-combo-box-drop-down-widthvar()

smartComboBox default width

--smart-combo-box-drop-down-heightvar()

smartComboBox default height