DropDownListProps
Represents the props of the Kendo UI for Vue DropDownList component.
Definition
Package:@progress/kendo-vue-dropdowns
Properties
accessKey?
string
Sets the accessKey attribute of the DropDownList.
adaptive?
boolean
Changes the rendering of the popup based on the screen size (see example).
adaptiveTitle?
string
Sets the title of the adaptive popup (see example).
ariaDescribedBy?
string
Sets the id values of the elements that describe the DropDownList, 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 DropDownList.
ariaLabelledBy?
string
Sets the id values of the elements that label the DropDownList.
className?
string
Sets additional CSS classes to the DropDownList.
dataItemKey?
string
Sets the key that the DropDownList uses to compare the data items. When you do not set dataItemKey, the DropDownList compares the items by reference (see example).
dataItems?
any[]
Sets the data of the DropDownList (see example).
defaultItem?
any
Sets the text of the default empty item. The type of the value must match the data type.
Sets the default value of the DropDownList (see example). It works like the default value of the native select HTML element.
delay?
number
Sets the delay in milliseconds before the DropDownList searches for an item. Use this option when filtering is off.
500
dir?
string
Sets the dir HTML attribute of the DropDownList.
disabled?
boolean
Sets the disabled state of the DropDownList.
fillMode?
"solid" | "outline" | "flat"
Configures the fillMode of the DropDownList.
The available options are:
- solid
- outline
- flat
undefined
filter?
string
Sets the value of the filter input.
filterable?
boolean
Turns on the filtering of the DropDownList (more information and examples).
Sets a function that returns the index of the focused item.
By default, the DropDownList focuses the first item that starts with the input text.
number
footer?
any
Sets the footer component of the DropDownList 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 DropDownList. Use it to change the default look of the group headers.
Sets a custom template for the sticky group header of the DropDownList. Use it to change the default look of the sticky group header.
header?
any
Sets the header component of the DropDownList popup (see example).
icon?
string
Sets the name of an existing font icon for the arrow button.
iconClassName?
string
Sets CSS classes to the expand icon DOM element.
id?
string
Sets the id of the hidden select element of the DropDownList. The floating label uses it as its target.
ignoreCase?
boolean
Turns on a case-insensitive search. Use this option when filtering is off.
true
itemRender?
any
Sets a custom template for the list items of the DropDownList (see example). Use it to change the default look of the list items.
label?
string
Renders a floating label for the DropDownList.
leftRightKeysNavigation?
boolean
When you set it to false, the left and right arrow keys do not move through the items of the DropDownList.
Use it when you place the DropDownList inside a toolbar that handles the left and right arrow keys.
true
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 DropDownList.
name?
string
Sets the name attribute of the hidden select element.
onBlur?
(event: DropDownListBlurEvent) => void
Fires each time the DropDownList loses focus.
onChange?
(event: DropDownListChangeEvent) => void
Fires each time the value of the DropDownList is about to change (see examples).
onClose?
(event: DropDownListCloseEvent) => void
Fires each time the popup of the DropDownList is about to close.
onFilterchange?
(event: DropDownListFilterChangeEvent) => void
Fires each time the user types in the filter input. You can filter the data based on the passed filter value.
onFocus?
(event: DropDownListFocusEvent) => void
Fires each time the DropDownList receives focus.
onOpen?
(event: DropDownListOpenEvent) => void
Fires each time the popup of the DropDownList is about to open.
onPagechange?
(event: DropDownListPageChangeEvent) => void
Fires when the virtual scrolling of the DropDownList is on and the component needs data for another page (see example).
opened?
boolean
Sets whether the popup of the DropDownList is open or closed.
placeholder?
string
The DropDownList, like the HTML select element, has no placeholder. Instead,
use the default item (see example).
Configures the popup of the DropDownList.
{ animate: true, height: '200px', anchor: '' }
required?
boolean
Sets whether null is a valid value for the component.
rounded?
"none" | "small" | "medium" | "large" | "full"
Configures the roundness of the DropDownList.
The available options are:
- none
- small
- medium
- large
- full
undefined
size?
"small" | "medium" | "large"
Configures the size of the DropDownList.
The available options are:
- small
- medium
- large
undefined
style?
any
Sets the styles of the DropDownList.
svgIcon?
SVGIcon
Sets the SVG icon for the arrow button. Use an icon from a Kendo UI for Vue theme.
tabIndex?
number
Sets the tabIndex attribute of the DropDownList.
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.
title?
string
Sets the title of the DropDownList.
valid?
boolean
Overrides the validity state of the component.
When you set valid, the component ignores the required property.
validate?
boolean
Sets whether the DropDownList 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 DropDownList (see example). The value can be a primitive (string or number) or a complex (object) type.
valueField?
string
Sets the data item field that holds the item value.
Sets a function that returns the value to submit. The DropDownList renders the returned value in an option of a hidden select element.
any
valuePrimitive?
boolean
Sets the type of the selected value. When you set it to true, the selected value must be a primitive value.
valueRender?
any
Sets a custom template for the element that shows the selected value (see example). Use it to change the default look of this element.
Configures the virtual scrolling of the DropDownList (see example).