ComboBoxProps
Represents the props of the KendoReact ComboBox component.
accessKey?
string
Specifies the accessKey of the ComboBox.
allowCustom?
boolean
Specifies whether the ComboBox allows user-defined values that are not present in the dataset (see example). 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 ComboBox.
clearButton?
boolean
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).
dataItemKey?
string
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).
defaultValue?
any
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.
filter?
string | null
Sets the value of ComboBox input. Useful for making the ComboBox input a controlled component.
filterable?
boolean
Enables the filtering functionality of the ComboBox (more information and examples).
focusedItemIndex?
(data: any, inputText: string, textField?: string) => number
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.
const focusedItemIndex = (data, inputText, textField) => {
let text = inputText.toLowerCase();
return data.findIndex(item =>
String(textField ? item[textField] : item).toLowerCase().includes(text));
};
<ComboBox focusedItemIndex={focusedItemIndex} />footer?
React.ReactNode
Sets the footer component of the ComboBox (see example).
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 ComboBox (see example).
iconClassName?
string
Sets CSS classes to the expand icon DOM element.
id?
string
Specifies the id of the component.
itemRender?
(li: ReactElement<HTMLLIElement>, itemProps: ListItemProps) => React.ReactNode
Fires when a ComboBox list item is about to be rendered (see example). Used to override the default appearance of the list items.
label?
string
Renders a floating label for the ComboBox.
listNoDataRender?
(element: ReactElement<HTMLDivElement>) => React.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.
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.
onChange?
(event: ComboBoxChangeEvent) => void
Fires each time the value of the ComboBox is about to change (see examples).
onClose?
(event: ComboBoxCloseEvent) => void
Fires each time the popup of the ComboBox is about to close.
onFilterChange?
(event: ComboBoxFilterChangeEvent) => void
Fires each time the user types in the filter input (see examples). You can filter the source based on the passed filtration value.
onFocus?
(event: ComboBoxFocusEvent) => void
Fires each time the user focuses the ComboBox.
onOpen?
(event: ComboBoxOpenEvent) => void
Fires each time the popup of the ComboBox is about to open.
onPageChange?
(event: ComboBoxPageChangeEvent) => void
Fires when both the virtual scrolling of the ComboBox is enabled and the component requires data for another page (more information and examples).
opened?
boolean
Sets the opened and closed state of the ComboBox.
placeholder?
string
The hint that is displayed when the ComboBox is empty.
popupSettings?
Configures the popup of the ComboBox.
required?
boolean
Specifies if null is a valid value for the component.
This property is part of the FormComponentProps interface.
style?
CSSProperties
The styles that are applied to the ComboBox.
suggest?
boolean
Enables the auto-completion of the text based on the first data item (see example).
tabIndex?
number
Specifies the tabIndex of the ComboBox.
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 ComboBox (more information and examples). It can either be of the primitive (string, numbers) or of the complex (objects) type.
virtual?
Configures the virtual scrolling of the ComboBox (more information and examples).
