DropDownListProps
Represents the props of the KendoVue DropDownList component.
Definition
Package:@progress/kendo-vue-dropdowns
Properties
accessKey?
string
Specifies the accessKey of the DropDownList.
adaptive?
boolean
Provides different rendering of the popup element based on the screen dimensions (see example).
adaptiveTitle?
string
Specifies the text that is rendered as title in the adaptive popup (see example).
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.
className?
string
Sets additional classes to the DropDownList.
dataItemKey?
string
Sets the key for comparing the data items of the DropDownList. If dataItemKey is not set, 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 defined value has to match the data type.
Sets the default value of the DropDownList (see example). Similar to the native select HTML element.
delay?
number
Sets the delay before an item search is performed. When filtration is disabled, use this option.
dir?
string
Represents the dir HTML attribute.
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 filtering input.
filterable?
boolean
Enables the filtering functionality of the DropDownList (more information and examples).
If set, the DropDownList 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 DropDownList (see example).
groupField?
string
Sets the data item field that represents the start of a group. Applicable to objects data.
Fires when a DropDownList group header item is about to be rendered. Used to override the default appearance of the group's headers.
Fires when a DropDownList 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 DropDownList (see example).
icon?
string
Defines the name for an existing arrow icon.
iconClassName?
string
Sets CSS classes to the expand icon DOM element.
id?
string
Specifies the id of the component.
ignoreCase?
boolean
Enables a case-insensitive search. When filtering is disabled, use this option.
itemRender?
any
Fires when a DropDownList 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 DropDownList.
leftRightKeysNavigation?
boolean
If set to false, the DropDownList will not navigate over its data through left and right keys.
Useful when the DropDownList is placed inside a toolbar which needs to handle left and right keys.
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 DropDownList.
name?
string
Specifies the name property of the select DOM element.
onBlur?
(event: DropDownListBlurEvent) => void
Fires each time the DropDownList gets blurred.
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 source based on the passed filtration value.
onFocus?
(event: DropDownListFocusEvent) => void
Fires each time the user focuses the DropDownList.
onOpen?
(event: DropDownListOpenEvent) => void
Fires each time the popup of the DropDownList is about to open.
onPagechange?
(event: DropDownListPageChangeEvent) => void
Fires when both the virtual scrolling of the DropDownList is enabled and the component requires data for another page (see example).
opened?
boolean
Sets the opened and closed state of the DropDownList.
placeholder?
string
There is no placeholder concept when it comes to DropDownList/HTML select element. The approach that we recommend in such cases is to use the default Item as it is shown here (see example).
Configures the popup of the DropDownList.
required?
boolean
Specifies if 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
The styles that are applied to the DropDownList.
svgIcon?
SVGIcon
Defines the svg icon in a Kendo UI for Vue theme.
tabIndex?
number
Specifies the tabIndex of the DropDownList.
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.
title?
string
Specifies the title of the component.
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 DropDownList (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.
Represents a callback function, which returns the value for submitting. The returned value will be rendered in an option of a hidden select element.
any
valuePrimitive?
boolean
Specifies the type of the selected value. If set to true, the selected value has to be of a primitive value.
valueRender?
any
Fires when the element which renders the value is about to be rendered (see example). Used to override the default appearance of the element.
Configures the virtual scrolling of the DropDownList (see example).