• Introduction
  • Getting Started
  • Vue 2 End of Support
  • Vue Wrappers End of Life
  • Native Components
    • Animation
    • Buttons
    • Chartsupdated
    • Conversational UI
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gauges
    • Gridupdated
    • Icons
    • Indicators
    • Inputsupdated
    • Labels
    • Layout
    • ListBox
    • ListView
    • Notification
    • PDF Processing
    • Popup
    • Progress Bars
    • Scheduler
    • ScrollView
    • Tooltip
    • TreeList
    • TreeView
    • Upload
  • Wrapper Components
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • FAQ
  • Troubleshooting
Components / Dropdowns / API / MultiSelectProps / 
New to Kendo UI for Vue? Start a free 30-day trial

MultiSelectProps

Represents the props of the Kendo UI for Vue MultiSelect component.

NameTypeDefaultDescription

accessKey?

string

Specifies the accessKey of the MultiSelect.

adaptive?

boolean

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

adaptiveTitle?

string

Specifies the text that is rendered as title in the adaptive popup.

allowCustom?

boolean

Specifies whether the MultiSelect 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.

ariaLabel?

string

Defines the aria-label attribute of the component.

ariaLabelledBy?

string

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

autoClose?

boolean

true

Determines whether to close the options list of the MultiSelect after the item selection is finished.

dataItemKey?

string

Sets the key for comparing the data items of the MultiSelect (see example). If dataItemKey is not set, 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. Similar to the native select HTML element.

dir?

string

Represents the dir HTML attribute.

disabled?

boolean

Sets the disabled state of the MultiSelect.

fillMode?

"null" | string

solid

Configures the fillMode of the MultiSelect.

The available options are:

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

filter?

string

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

filterable?

boolean

Enables the filtering functionality of the MultiSelect (more information and examples).

focusedItemIndex?

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

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.

footer?

any

Sets the footer component of the MultiSelect (see example).

groupField?

string

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

groupHeaderItemRender?

any

Fires when a MultiSelect group header item is about to be rendered. Used to override the default appearance of the group's headers.

groupStickyHeaderItemRender?

any

Fires when a MultiSelect sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component.

header?

any

Sets the header component of the MultiSelect (see example).

id?

string

Specifies the id of the component.

itemRender?

any

Fires when a MultiSelect 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 MultiSelect.

listNoDataRender?

any

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.

loading?

boolean

Sets the loading state of the MultiSelect (see example).

name?

string

Specifies the name property of the input DOM element.

onBlur?

(event: MultiSelectBlurEvent) => void

Fires each time the MultiSelect gets blurred.

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 source based on the passed filtration value.

onFocus?

(event: MultiSelectFocusEvent) => void

Fires each time the user focuses the MultiSelect.

onOpen?

(event: MultiSelectOpenEvent) => void

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

onPagechange?

(event: MultiSelectPageChangeEvent) => void

Fires when both the virtual scrolling of the MultiSelect is enabled and when the component requires data for another page (see example).

opened?

boolean

Sets the opened and closed state of the MultiSelect.

placeholder?

string

The hint that is displayed when the MultiSelect is empty.

popupSettings?

DropDownsPopupSettings

Configures the popup of the MultiSelect.

removeTagIcon?

string

Sets the close icon of the tag items.

required?

boolean

Specifies if null is a valid value for the component.

rounded?

"null" | string

medium

Configures the roundness of the MultiSelect.

The available options are:

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

size?

"null" | string

medium

Configures the size of the MultiSelect.

The available options are:

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

tabIndex?

number

Specifies the tabIndex of the MultiSelect.

tagRender?

any

Fires when a tag element is about to be rendered (see example). Used to override the default appearance of the element.

tags?

TagData[]

Sets the tags of the MultiSelect (see example).

tagsRounded?

"null" | string

medium

Configures the roundness of the tags in MultiSelect.

The available options are:

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

textField?

string

Sets the data item field that represents the item text (see example). 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.

validate?

boolean

Sets the validate of the input.

validationMessage?

string

Controls the form error message of the component. If set to an empty string, no error will be thrown.

validityStyles?

boolean

If set to false, no visual representation of the invalid state of the component will be applied.

value?

any[]

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

valueField?

string

Sets the data item field that represents the item value.

valuePrimitive?

boolean

Specifies the type of the selected value. If set to true, the selected value has to be of a primitive value.

virtual?

VirtualizationSettings

Configures the virtual scrolling of the MultiSelect (see example).

In this article

Not finding the help you need?

Contact Support