MultiSelectProps
Represents the props of the Kendo UI for Vue MultiSelect component.
Definition
Package:@progress/kendo-vue-dropdowns
Properties
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
Determines whether to close the options list of the MultiSelect after the item selection is finished.
true
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?
"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 filtering input. Useful for making the filtering input a controlled component.
filterable?
boolean
Enables the filtering functionality of the MultiSelect (more information and examples).
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.
number
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.
Fires when a MultiSelect group header item is about to be rendered. Used to override the default appearance of the group's headers.
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.
inputAttributes?
Object
Sets the built-in HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
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.
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.
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?
"none" | "small" | "medium" | "large" | "full"
Configures the roundness of the MultiSelect.
The available options are:
- none
- small
- medium
- large
- full
undefined
size?
"small" | "medium" | "large"
Configures the size of the MultiSelect.
The available options are:
- small
- medium
- large
undefined
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.
Sets the tags of the MultiSelect (see example).
tagsRounded?
"none" | "small" | "medium" | "large" | "full"
Configures the roundness of the tags in MultiSelect.
The available options are:
- none
- small
- medium
- large
- circle
- full
undefined
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.
Configures the virtual scrolling of the MultiSelect (see example).