Introduction
    Getting Started
    Native Components
    • Animation
    • Buttons
    • Charts
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gauges
    • Gridupdated
    • Indicatorsupdated
    • Inputsupdated
    • Labels
    • Layoutupdated
    • Notification
    • PDF Processing
    • Popup
    • Progress Bars
    • Scheduler
    • ScrollView
    • Tooltip
    • TreeListnew
    • TreeView
    • Upload
    Wrapper Components
    Sample Applications
    Styling & Themes
    Common Features
    Project Setup
    Knowledge Base
    Changelog
    FAQ
Components / Dropdowns / API / DropDownListProps / 
New to Kendo UI for Vue? Start a free 30-day trial

DropDownListProps

Represents the props of the KendoVue DropDownList component.

NameTypeDefaultDescription

accessKey?

string

Specifies the accessKey of the DropDownList.

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

Adds aris-label for 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.

defaultValue?

any

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?

"null" | string

solid

Configures the fillMode of the DropDownList.

The available options are:

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

filter?

string

Sets the value of filtering input.

filterable?

boolean

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

footer?

any

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

header?

any

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

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.

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 DropDownList.

name?

string

Specifies the name property of the select DOM element.

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).

popupSettings?

DropDownsPopupSettings

Configures the popup of the DropDownList.

required?

boolean

Specifies if null is a valid value for the component.

rounded?

"null" | string

medium

Configures the roundness of the DropDownList.

The available options are:

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

size?

"null" | string

medium

Configures the size of the DropDownList.

The available options are:

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

style?

any

The styles that are applied to the DropDownList.

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.

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.

virtual?

VirtualizationSettings

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

Methods

focusedItemIndex

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.

Parameters

data

any

inputText

string

textField?

string

Returns

number

onBlur

Fires each time the DropDownList gets blurred.

Parameters

event

DropDownListBlurEvent

onChange

Fires each time the value of the DropDownList is about to change (see examples).

Parameters

event

DropDownListChangeEvent

onClose

Fires each time the popup of the DropDownList is about to close.

Parameters

event

DropDownListCloseEvent

onFilterchange

Fires each time the user types in the filter input. You can filter the source based on the passed filtration value.

Parameters

event

DropDownListFilterChangeEvent

onFocus

Fires each time the user focuses the DropDownList.

Parameters

event

DropDownListFocusEvent

onOpen

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

Parameters

event

DropDownListOpenEvent

onPagechange

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

Parameters

event

DropDownListPageChangeEvent

valueMap

Represents a callback function, which returns the value for submitting. The returned value will be rendered in an option of a hidden select element.

Parameters

value

any

Returns

any

In this article

Not finding the help you need?

Contact Support