MultiSelect
Represents the Kendo UI for Vue MultiSelect component. Use the MultiSelect to select more than one item from a list.
Definition
Package:@progress/kendo-vue-dropdowns
Properties Interface:MultiSelectProps
Syntax:
<MultiSelect :data-items="sports" :default-value="['Basketball', 'Cricket']" />
Properties
accessKey?
string
Sets the accessKey attribute of the MultiSelect.
adaptive?
boolean
Changes the rendering of the popup based on the screen size.
adaptiveTitle?
string
Sets the title of the adaptive popup.
allowCustom?
boolean
Sets whether the MultiSelect accepts custom values that are not in the data (see example). Defaults to false.
ariaDescribedBy?
string
Sets the id values of the elements that describe the MultiSelect, like the HTML aria-describedby attribute.
For example, these elements can contain an error or a hint message.
ariaLabel?
string
Sets the aria-label attribute of the MultiSelect.
ariaLabelledBy?
string
Sets the id values of the elements that label the MultiSelect.
autoClose?
boolean
Sets whether the popup of the MultiSelect closes after the user selects an item.
true
checkboxes?
boolean
Sets whether the MultiSelect renders checkboxes in the select-all header and in each list item. The checkbox state shows the selected state of the items.
false
dataItemKey?
string
Sets the key that the MultiSelect uses to compare the data items (see example). When you do not set dataItemKey, the MultiSelect compares the items by reference.
dataItems?
any[]
Sets the data of the MultiSelect (see example).
defaultValue?
any[]
Sets the default value of the MultiSelect. It works like the default value of the native select HTML element.
dir?
string
Sets the dir HTML attribute of the MultiSelect.
disabled?
boolean
Sets the disabled state of the MultiSelect.
fillMode?
"solid" | "outline" | "flat" | "link"
Configures the fillMode of the MultiSelect.
The available options are:
- solid
- outline
- flat
- link
undefined
filter?
string
Sets the value of the filter input. Use it when you want to control the filter input.
filterable?
boolean
Turns on the filtering of the MultiSelect (more information and examples).
Sets a function that returns the index of the focused item.
By default, the MultiSelect focuses the first item that starts with the input text.
number
footer?
any
Sets the footer component of the MultiSelect popup (see example).
groupField?
string
Sets the data item field that marks the start of a group. Applies to object data.
Sets a custom template for the group header items of the MultiSelect. Use it to change the default look of the group headers.
Sets a custom template for the sticky group header of the MultiSelect. Use it to change the default look of the sticky group header.
header?
any
Sets the header component of the MultiSelect popup (see example).
id?
string
Sets the id of the input element of the MultiSelect. The floating label uses it as its target.
inputAttributes?
Object
Sets the built-in HTML attributes of the inner focusable input element.
You cannot change the attributes that some component features need.
itemRender?
any
Sets a custom template for the list items of the MultiSelect (see example). Use it to change the default look of the list items.
label?
string
Renders a floating label for the MultiSelect.
Sets a custom template for the element that the popup shows when there is no data (see example). Use it to change the default look of this element.
loading?
boolean
Sets the loading state of the MultiSelect (see example).
name?
string
Sets the name property of the input DOM element.
onBlur?
(event: MultiSelectBlurEvent) => void
Fires each time the MultiSelect loses focus.
onChange?
(event: MultiSelectChangeEvent) => void
Fires each time the value of the MultiSelect is about to change (see examples).
onClose?
(event: MultiSelectCloseEvent) => void
Fires each time the popup of the MultiSelect is about to close.
onFilterchange?
(event: MultiSelectFilterChangeEvent) => void
Fires each time the user types in the filter input (see example). You can filter the data based on the passed filter value.
onFocus?
(event: MultiSelectFocusEvent) => void
Fires each time the MultiSelect receives focus.
onOpen?
(event: MultiSelectOpenEvent) => void
Fires each time the popup of the MultiSelect is about to open.
onPagechange?
(event: MultiSelectPageChangeEvent) => void
Fires when the virtual scrolling of the MultiSelect is on and the component needs data for another page (see example).
onSelectAllChange?
(event: MultiSelectSelectAllChangeEvent) => void
Fires when the user clicks the select-all item. When you handle this event, you control the select-all logic. Use it in virtualization scenarios where you manage the full data set.
opened?
boolean
Sets whether the popup of the MultiSelect is open or closed.
placeholder?
string
Sets the hint that the MultiSelect shows when it is empty.
Configures the popup of the MultiSelect.
{ animate: true, height: '200px', anchor: '' }
removeTagIcon?
string
Sets the close icon of the tags.
required?
boolean
Sets whether null is a valid value for the component.
rounded?
"none" | "small" | "medium" | "large" | "full"
Configures the roundness of the MultiSelect.
The available options are:
- none
- small
- medium
- large
- full
undefined
selectAll?
boolean
Sets whether a built-in Select all option shows at the top of the popup list.
When the user selects this option, the MultiSelect toggles all items that apply.
false
size?
"small" | "medium" | "large"
Configures the size of the MultiSelect.
The available options are:
- small
- medium
- large
undefined
summarizeAfter?
number
Sets the maximum number of single tags that the MultiSelect shows before it shows a summary tag.
When the number of selected items is greater than this value, the MultiSelect shows the first summarizeAfter items
as single tags and groups the rest of the items in a summary tag.
10
tabIndex?
number
Sets the tabIndex attribute of the MultiSelect.
0
tagRender?
any
Sets a custom template for the tags (see example). Use it to change the default look of the tags.
Sets the tags of the MultiSelect (see example).
tagsRounded?
"none" | "small" | "medium" | "large" | "full"
Configures the roundness of the tags in the MultiSelect.
The available options are:
- none
- small
- medium
- large
- circle
- full
undefined
textField?
string
Sets the data item field that holds the item text (see example). If the data contains only primitive values, do not set it.
valid?
boolean
Overrides the validity state of the component.
When you set valid, the component ignores the required property.
validate?
boolean
Sets whether the MultiSelect validates its value.
validationMessage?
string
Sets the form error message of the component. If you set it to an empty string, the component shows no error.
validityStyles?
boolean
Shows or hides the invalid state styles of the component. When you set it to false, the component shows no invalid state styles.
value?
any[]
Sets the value of the MultiSelect (see example). The values can be primitives (strings or numbers) or complex types (objects).
valueField?
string
Sets the data item field that holds the item value.
valuePrimitive?
boolean
Sets the type of the selected value. When you set it to true, the selected value must be a primitive value.
Configures the virtual scrolling of the MultiSelect (see example).