Components / ListBox / API / ListBoxProps / 
New to Kendo UI for Vue? Start a free 30-day trial

ListBoxProps

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

NameTypeDefaultDescription

className?

string

Sets a class of the Tooltip animation container.

dataItems

any[]

Set the data of the ListBox.

draggable?

boolean

Makes the items of the ListBox draggable.

item?

string | object | Function

Defines the component that will be rendered for each item of the data collection.

keyField?

string

The field that is used for rendering key of the items.

onDragleave?

(event: ListBoxDragLeaveEvent) => void

Fires when a dragged element or text selection leaves the ListBox element.

onDragover?

(event: ListBoxDragEvent) => void

Fires when an the user drags over an item from the ListBox. The event contains information for the item that is dragged over.

onDragstart?

(event: ListBoxDragEvent) => void

Fires when an the user start to drag an item from the ListBox. The event contains information for the item that is being dragged.

onDrop?

(event: ListBoxDragEvent) => void

Fires when an the user drops an item. The event contains information for the drop target item.

onItemclick?

(event: ListBoxItemClickEvent) => void

Fires when an item from the ListBox is clicked. Contains the clicked item.

onKeydown?

(event: ListBoxKeyDownEvent) => void

Fires on keydown over the ListBox list items. It can be use to add keyboard extra keyboard navigation option.

selectedField?

string

Set the selected field of the ListBox. Based on that value of that field, an item will be selected or not.

size?

"null" | string

medium

Configures the size of the ListBox.

The available options are:

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

tabIndex?

number

Sets the tabIndex attribute of the ListBox.

textField

string

Sets the data item field that represents the item text. If the data contains only primitive values, do not define it.

toolbar?

string | object | Function

Renders a toolbar component next to the ListBox.

toolbarPosition?

string

Sets the position of the toolbar of the ListBox if one is set. The ListBox may have no toolbar.

  • The possible values are:
  • top
  • bottom
  • left
  • right (Default)
  • none

valueField?

string

The field that be used during form submit. Defaults to the textField if not set.

In this article

Not finding the help you need?

Contact Support