Components
    • Animation
    • Barcodes
    • Buttons
    • Charts
    • Common Utilities
    • Conversational UI
    • Data Grid
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Indicators
    • Inputs
    • Labels
    • Layout
    • ListBox
    • ListView
    • Mapbeta
    • Notification
    • PDF Processing
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeView
    • Upload
    Sample Applications
    Styling & Themes
    Common Features
    Project Setup
    Changelog

MultiColumnComboBoxProps

Represents the properties of the MultiColumnComboBox component.

NameTypeDefaultDescription

accessKey?

string

Specifies the accessKey of the MultiColumnComboBox.

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.

ariaLabelledBy?

string

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

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.

disabled?

boolean

Sets the disabled state of the MultiColumnComboBox.

fillMode?

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

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.

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.

header?

React.ReactNode

Sets the header component of the MultiColumnComboBox.

iconClassName?

string

Sets CSS classes to the expand icon DOM element.

id?

string

Specifies the id of the component.

label?

string

Renders a floating label for the MultiColumnComboBox.

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.

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.

required?

boolean

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

rounded?

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

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" | "medium" | "large"

medium

Configures the size of the MultiColumnComboBox.

The available options are:

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

style?

React.CSSProperties

The styles that are applied to the MultiColumnComboBox.

suggest?

boolean

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

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.

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.

virtual?

VirtualizationSettings

Configures the virtual scrolling of the MultiColumnComboBox.

Methods

focusedItemIndex

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.

Parameters

data

any

inputText

string

textField?

string

Returns

number

itemRender

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

Parameters

li

ReactElement<HTMLLIElement>

itemProps

ListItemProps

Returns

ReactNode

listNoDataRender

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

element

ReactElement<HTMLDivElement>

Returns

ReactNode

onBlur

Fires each time the MultiColumnComboBox gets blurred.

Parameters

event

ComboBoxBlurEvent

onChange

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

Parameters

event

ComboBoxChangeEvent

onClose

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

Parameters

event

ComboBoxCloseEvent

onFilterChange

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

Parameters

event

ComboBoxFilterChangeEvent

onFocus

Fires each time the user focuses the MultiColumnComboBox.

Parameters

event

ComboBoxFocusEvent

onOpen

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

Parameters

event

ComboBoxOpenEvent

onPageChange

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

Parameters

event

ComboBoxPageChangeEvent

valueRender

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

Parameters

rendering

ReactElement<HTMLSpanElement>

Returns

ReactNode