MultiSelectProps
Represents the props of the KendoReact MultiSelect component.
Name | Type | Default | Description |
---|---|---|---|
accessKey? |
|
Specifies the | |
adaptive? |
|
Providing different rendering of the popup element based on the screen dimensions. | |
adaptiveFilter? |
|
Sets the value of the adaptive filtering input of the of MultiSelect. | |
adaptiveTitle? |
|
Specifies the text that is rendered as title in the adaptive popup. | |
allowCustom? |
|
Specifies whether the MultiSelect allows user-defined values that are not present in the dataset (see example). Defaults to | |
ariaDescribedBy? |
|
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? |
|
Identifies the element(s) which will label the component. | |
autoClose? |
|
|
Determines whether to close the options list of the MultiSelect after the item selection is finished.
|
className? |
|
Sets additional classes to the MultiSelect. | |
data? |
|
Sets the data of the MultiSelect (see example). | |
dataItemKey? |
|
Sets the key for comparing the data items of the MultiSelect (see example). If | |
defaultValue? |
|
Sets the default value of the MultiSelect. Similar to the native | |
dir? |
|
Represents the | |
disabled? |
|
Sets the disabled state of the MultiSelect. | |
fillMode? |
|
|
Configures the The available options are:
|
filter? |
|
Sets the value of filtering input. Useful for making the filtering input a controlled component. | |
filterable? |
|
Enables the filtering functionality of the MultiSelect (more information and examples). | |
footer? |
|
Sets the footer component of the MultiSelect (see example). | |
groupField? |
|
Sets the data item field that represents the start of a group. Applicable to objects data. | |
header? |
|
Sets the header component of the MultiSelect (see example). | |
id? |
|
Specifies the id of the component. | |
label? |
|
Renders a floating label for the MultiSelect. | |
loading? |
|
Sets the loading state of the MultiSelect (see example). | |
name? |
|
Specifies the This property is part of the FormComponentProps interface. | |
opened? |
|
Sets the opened and closed state of the MultiSelect. | |
placeholder? |
|
The hint that is displayed when the MultiSelect is empty. | |
popupSettings? |
|
Configures the popup of the MultiSelect. | |
required? |
|
Specifies if This property is part of the FormComponentProps interface. | |
rounded? |
|
|
Configures the The available options are:
|
size? |
|
|
Configures the The available options are:
|
skipDisabledItems? |
|
Defines if MultiSelect's disabled items will be skipped or focused when navigating through the list of items using a keyboard. Defaults to | |
style? |
|
The styles that are applied to the MultiSelect. | |
tabIndex? |
|
Specifies the | |
tags? |
|
Sets the tags of the MultiSelect (see example). | |
textField? |
|
Sets the data item field that represents the item text (see example). If the data contains only primitive values, do not define it. | |
valid? |
|
Overrides the validity state of the component.
If This property is part of the FormComponentProps interface. | |
validationMessage? |
|
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? |
|
If set to This property is part of the FormComponentProps interface. | |
value? |
|
Sets the value of the MultiSelect (see example). It can either be of the primitive (string, numbers) or of the complex (objects) type. | |
virtual? |
|
Configures the virtual scrolling of the MultiSelect (see example). |
Methods
focusedItemIndex | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
If set, the MultiSelect will use it to get the focused item index. Default functionality returns the first item which starts with the input text.
| ||||||||||||
| ||||||||||||
|
groupHeaderItemRender | |||||||||
---|---|---|---|---|---|---|---|---|---|
Fires when a DropDownList's group header item is about to be rendered. Used to override the default appearance of the group's headers. | |||||||||
| |||||||||
|
groupStickyHeaderItemRender | |||||||||
---|---|---|---|---|---|---|---|---|---|
Fires when a DropDownList's sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component. | |||||||||
| |||||||||
|
itemRender | |||||||||
---|---|---|---|---|---|---|---|---|---|
Fires when a MultiSelect item is about to be rendered (see example). Used to override the default appearance of the list items. | |||||||||
| |||||||||
|
listNoDataRender | ||||||
---|---|---|---|---|---|---|
Fires when the element which indicates no data in the popup is about to be rendered (see example). Used to override the default appearance of the element. | ||||||
| ||||||
|
onBlur | ||||||
---|---|---|---|---|---|---|
Fires each time the MultiSelect gets blurred. | ||||||
|
onCancel | ||||||
---|---|---|---|---|---|---|
Fires each time the popup of the MultiSelect is about to cancel in (adaptive mode). | ||||||
|
onChange | ||||||
---|---|---|---|---|---|---|
Fires each time the value of the MultiSelect is about to change (see examples). | ||||||
|
onClose | ||||||
---|---|---|---|---|---|---|
Fires each time the popup of the MultiSelect is about to close. | ||||||
|
onFilterChange | ||||||
---|---|---|---|---|---|---|
Fires each time the user types in the filter input (see example). You can filter the source based on the passed filtration value. | ||||||
|
onFocus | ||||||
---|---|---|---|---|---|---|
Fires each time the user focuses the MultiSelect. | ||||||
|
onOpen | ||||||
---|---|---|---|---|---|---|
Fires each time the popup of the MultiSelect is about to open. | ||||||
|
onPageChange | ||||||
---|---|---|---|---|---|---|
Fires when both the virtual scrolling of the MultiSelect is enabled and when the component requires data for another page (see example). | ||||||
|
tagRender | |||||||||
---|---|---|---|---|---|---|---|---|---|
Fires when a tag element is about to be rendered (see example). Used to override the default appearance of the element. | |||||||||
| |||||||||
|