New to KendoReactLearn about KendoReact Free.

MultiColumnComboBoxProps

Represents the properties of the MultiColumnComboBox component.

NameTypeDefaultDescription

accessKey?

string

Specifies the accessKey of the MultiColumnComboBox.

adaptive?

boolean

false

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

jsx
<ComboBox adaptive={true} />

adaptiveFilter?

string

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

jsx
<ComboBox adaptiveFilter="Option" />

adaptiveSubtitle?

string

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

jsx
<ComboBox adaptiveSubtitle="Adaptive Popup Subtitle" />



</td>
</tr>
<tr>
<td class="table-cell-name">


#### adaptiveTitle?


</td>
<td type class="table-cell-type">


<code>


string


</code>


</td>
<td class="table-cell-default">




</td>
<td class="table-cell-comment">


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.

```jsx
<ComboBox adaptiveTitle="Adaptive Popup Title" />

allowCustom?

boolean

Specifies whether the MultiColumnComboBox allows user-defined values that are not present in the dataset. Defaults to false.

ariaDescribedBy?

string

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.

jsx
<ComboBox ariaDescribedBy="descriptionId" />

ariaLabel?

string

The accessible label of the component.

jsx
<ComboBox ariaLabel="ComboBox Label" />

ariaLabelledBy?

string

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

jsx
<ComboBox ariaLabelledBy="labelId" />

className?

string

Sets additional classes to the MultiColumnComboBox.

clearButton?

boolean

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

columns

MultiColumnComboBoxColumn[]

Determines the columns array of the MultiColumnComboBox.

data?

any[]

Sets the data of the MultiColumnComboBox.

dataItemKey?

string

Sets the key for comparing the data items of the MultiColumnComboBox. If dataItemKey is not set, the MultiColumnComboBox compares the items by reference.

defaultValue?

any

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

dir?

string

Represents the dir HTML attribute.

jsx
<ComboBox dir="rtl" />

disabled?

boolean

Sets the disabled state of the MultiColumnComboBox.

fillMode?

"null" | "flat" | "solid" | "outline"

solid

Configures the fillMode of the MultiColumnComboBox.

The available options are:

  • solid
  • flat
  • outline
  • null—Does not set a fillMode className.

filter?

"null" | string

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

filterable?

boolean

Enables the filtering functionality of the MultiColumnComboBox.

focusedItemIndex?

(data: any, inputText: string, textField?: string) => number

If set, the MultiColumnComboBox will use it to get the focused item index. Default functionality returns the first item which starts with the input text.

React.ReactNode

Sets the footer component of the MultiColumnComboBox.

groupField?

string

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

jsx
<ComboBox groupField="category" />

groupHeaderItemRender?

(li: ReactElement<HTMLLIElement>, itemProps: ListGroupItemProps) => ReactNode

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.

jsx
<ComboBox groupHeaderItemRender={(li, itemProps) => <li>{itemProps.dataItem}</li>} />

groupMode?

string

Defines the classic or modern type of the grouping's visualization. Defaults to modern.

jsx
<ComboBox groupMode="classic" />

groupStickyHeaderItemRender?

(div: ReactElement<HTMLDivElement>, stickyHeaderProps: GroupStickyHeaderProps) => 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.

jsx
<ComboBox groupStickyHeaderItemRender={(div, stickyHeaderProps) => <div>{stickyHeaderProps.group}</div>} />

React.ReactNode

Sets the header component of the MultiColumnComboBox.

iconClassName?

string

Sets CSS classes to the expand icon DOM element.

jsx
<ComboBox iconClassName="custom-icon-class" />

id?

string

Specifies the id of the component.

jsx
<ComboBox id="comboBoxId" />

inputAttributes?

React.InputHTMLAttributes<HTMLInputElement>

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

jsx
<ComboBox inputAttributes={{ maxLength: 10 }} />

itemRender?

(li: ReactElement<HTMLLIElement>, itemProps: ListItemProps) => ReactNode

Fires when a MultiColumnComboBox list item is about to be rendered. Used to override the default appearance of the list items.

label?

string

Renders a floating label for the MultiColumnComboBox.

listNoDataRender?

(element: ReactElement<HTMLDivElement>) => ReactNode

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.

jsx
<ComboBox listNoDataRender={(element) => <div>No data available</div>} />

loading?

boolean

Sets the loading state of the MultiColumnComboBox.

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 MultiColumnComboBox gets blurred.

onChange?

(event: ComboBoxChangeEvent) => void

Fires each time the value of the MultiColumnComboBox is about to change.

onClose?

(event: ComboBoxCloseEvent) => void

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

onFilterChange?

(event: ComboBoxFilterChangeEvent) => void

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

onFocus?

(event: ComboBoxFocusEvent) => void

Fires each time the user focuses the MultiColumnComboBox.

onOpen?

(event: ComboBoxOpenEvent) => void

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

onPageChange?

(event: ComboBoxPageChangeEvent) => void

Fires when both the virtual scrolling of the MultiColumnComboBox is enabled and the component requires data for another page.

opened?

boolean

Sets the opened and closed state of the MultiColumnComboBox.

placeholder?

string

The hint that is displayed when the MultiColumnComboBox is empty.

popupSettings?

DropDownsPopupSettings

Configures the popup of the MultiColumnComboBox.

prefix?

CustomComponent<any>

Sets a custom prefix to the MultiColumnComboBox component.

required?

boolean

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

rounded?

"null" | "small" | "large" | "medium" | "full"

medium

Configures the roundness of the MultiColumnComboBox.

The available options are:

  • small
  • medium
  • large
  • full
  • null—Does not set a rounded className.

size?

"null" | "small" | "large" | "medium"

medium

Configures the size of the MultiColumnComboBox.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.

skipDisabledItems?

boolean

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

jsx
<ComboBox skipDisabledItems={false} />

style?

React.CSSProperties

The styles that are applied to the MultiColumnComboBox.

suffix?

CustomComponent<any>

Sets a custom suffix to the MultiColumnComboBox component.

suggest?

boolean

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

jsx
<ComboBox suggest={true} />

svgIcon?

SVGIcon

Sets the specified SVG icon.

jsx
<ComboBox svgIcon={{ name: 'custom-icon' }} />

tabIndex?

number

Specifies the tabIndex of the MultiColumnComboBox.

textField?

string

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

jsx
<ComboBox textField="name" />

title?

string

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

jsx
<ComboBox title="ComboBox Title" />

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.

validationMessage?

string

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.

validityStyles?

boolean

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.

value?

any

Sets the value of the MultiColumnComboBox. It can either be of the primitive (string, numbers) or of the complex (objects) type.

valueRender?

(rendering: ReactElement<HTMLSpanElement>) => ReactNode

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

jsx
<ComboBox valueRender={(rendering) => <span>{rendering}</span>} />

virtual?

VirtualizationSettings

Configures the virtual scrolling of the MultiColumnComboBox.

Not finding the help you need?
Contact Support