New to KendoReactStart a free 30-day trial

ComboBoxProps

Interface

Represents the props of the KendoReact ComboBox component.

Definition

Package:@progress/kendo-react-dropdowns

Properties

Specifies the accessKey of the ComboBox.

adaptive?

boolean

Providing different rendering of the popup element based on the screen dimensions.

Default:

false

Sets the value of the adaptive filtering input of the ComboBox.

Specifies the text that is rendered as subtitle in the adaptive popup(action sheet). Applicable only when adaptive is set to true.

Specifies the text that is rendered as title in the adaptive popup(action sheet). Applicable only when adaptive is set to true. If not provided, the title will be the same as the label.

Specifies whether the ComboBox allows user-defined values that are not present in the dataset (see example). Defaults to false.

Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.

The accessible label of the component.

Identifies the element(s) which will label the component.

Sets additional classes to the ComboBox.

If clearButton is set to true, the ComboBox renders a button on hovering over the component. Clicking this button resets the value of the ComboBox to undefined and triggers the change event.

data?

any[]

Sets the data of the ComboBox (more information and examples).

Sets the key for comparing the data items of the ComboBox. If dataItemKey is not set, the ComboBox compares the items by reference (see example).

Sets the default value of the ComboBox. Similar to the native select HTML element.

dir?

string

Represents the dir HTML attribute.

disabled?

boolean

Sets the disabled state of the ComboBox.

fillMode?

"solid" | "flat" | "outline"

Configures the fillMode of the ComboBox.

The available options are:

  • solid
  • flat
  • outline
Default:

undefined (theme-controlled)

filter?

null | string

Sets the value of ComboBox input. Useful for making the ComboBox input a controlled component.

Enables the filtering functionality of the ComboBox (more information and examples).

If set, the ComboBox will use it to get the focused item index.

Default functionality returns the first item which starts with the input text.

Parameters:dataanyinputTextstringtextField?stringReturns:

number

ReactNode

Sets the footer component of the ComboBox (see example).

Sets the data item field that represents the start of a group. Applicable to objects data.

Fires when a ComboBox group header item is about to be rendered. Used to override the default appearance of the group's headers when the component is configured in modern group mode.

Parameters:liReactElement​<HTMLLIElement, string | JSXElementConstructor​<any>>itemPropsListGroupItemPropsReturns:

ReactNode

Fires when a ComboBox sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component.

Parameters:divReactElement​<HTMLDivElement, string | JSXElementConstructor​<any>>stickyHeaderPropsGroupStickyHeaderPropsReturns:

ReactNode

ReactNode

Sets the header component of the ComboBox (see example).

Sets CSS classes to the expand icon DOM element.

id?

string

Specifies the id of the component.

Specifies whether the ComboBox text matching should be case-insensitive when selecting values on blur or Enter key. When set to true, typing "football" will match and select "Football" from the list. Defaults to false (case-sensitive matching).

inputAttributes?

InputHTMLAttributes​<HTMLInputElement>

Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.

Fires when a ComboBox list item is about to be rendered (see example). Used to override the default appearance of the list items.

Parameters:liReactElement​<HTMLLIElement, string | JSXElementConstructor​<any>>itemPropsListItemPropsReturns:

ReactNode

label?

string

Renders a floating label for the ComboBox.

Fires when the element which indicates no data in the popup is about to be rendered. Used to override the default appearance of the element.

Parameters:elementReactElement​<HTMLDivElement, string | JSXElementConstructor​<any>>Returns:

ReactNode

loading?

boolean

Sets the loading state of the ComboBox (see example).

name?

string

Specifies the name property of the input DOM element.

This property is part of the FormComponentProps interface.

onBlur?

(event: ComboBoxBlurEvent) => void

Fires each time the ComboBox gets blurred.

Parameters:eventComboBoxBlurEvent

Fires each time the value of the ComboBox is about to change (see examples).

Parameters:eventComboBoxChangeEvent

Fires each time the popup of the ComboBox is about to close.

Parameters:eventComboBoxCloseEvent

Fires each time the user types in the filter input (see examples). You can filter the source based on the passed filtration value.

Parameters:eventComboBoxFilterChangeEvent

Fires each time the user focuses the ComboBox.

Parameters:eventComboBoxFocusEvent

onOpen?

(event: ComboBoxOpenEvent) => void

Fires each time the popup of the ComboBox is about to open.

Parameters:eventComboBoxOpenEvent

Fires when both the virtual scrolling of the ComboBox is enabled and the component requires data for another page (more information and examples).

Parameters:eventComboBoxPageChangeEvent

opened?

boolean

Sets the opened and closed state of the ComboBox.

The hint that is displayed when the ComboBox is empty.

Configures the popup of the ComboBox.

prefix?

CustomComponent​<any>

Sets a custom prefix to the ComboBox component.

required?

boolean

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

rounded?

"small" | "medium" | "large" | "full" | "none"

Configures the roundness of the ComboBox.

The available options are:

  • small
  • medium
  • large
  • full
Default:

undefined (theme-controlled)

size?

"small" | "medium" | "large"

Configures the size of the ComboBox.

The available options are:

  • small
  • medium
  • large
Default:

undefined (theme-controlled)

Defines if ComboBox's disabled items will be skipped or focused when navigating through the list of items using a keyboard. Defaults to true.

style?

CSSProperties

The styles that are applied to the ComboBox.

suffix?

CustomComponent​<any>

Sets a custom suffix to the ComboBox component.

suggest?

boolean

Enables the auto-completion of the text based on the first data item (see example).

svgIcon?

SVGIcon

Sets the specified SVG icon.

tabIndex?

number

Specifies the tabIndex of the ComboBox.

Sets the data item field that represents the item text. If the data contains only primitive values, do not define it.

title?

string

Sets the title attribute to the underlying input element of the ComboBox.

valid?

boolean

Overrides the validity state of the component. If valid is set, the required property will be ignored.

This property is part of the FormComponentProps interface.

Controls the form error message of the component. If set to an empty string, no error will be thrown.

This property is part of the FormComponentProps interface.

If set to false, no visual representation of the invalid state of the component will be applied.

This property is part of the FormComponentProps interface.

Sets the value of the ComboBox (more information and examples).

Fires when the ComboBox input element is about to be rendered. Use it to override the default appearance of the component.

Parameters:renderingReactElement​<HTMLSpanElement, string | JSXElementConstructor​<any>>Returns:

ReactNode

Configures the virtual scrolling of the ComboBox (more information and examples).

webMcp?

boolean | WebMcpProps

Enables Web MCP tool registration for this component. Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.