New to Kendo UI for Vue? Start a free 30-day trial

ListBoxProps

Interface

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

Definition

Package:@progress/kendo-vue-listbox

Properties

Sets a CSS class on the ListBox element.

Sets the data of the ListBox.

Default:

[]

draggable?

boolean

Sets whether the user can drag the items of the ListBox.

Default:

false

item?

string | object | Function

Sets a custom template for each item of the ListBox. Accepts a Vue component, a render function, or a slot name. The template receives the dataItem and the index of the item.

keyField?

string

Sets the data item field that the ListBox uses as the key of each item.

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

Parameters:eventListBoxDragLeaveEvent

Fires when the user drags an item over an item of the ListBox. The event contains the item under the pointer.

Parameters:eventListBoxDragEvent

Fires when the user starts to drag an item of the ListBox. The event contains the dragged item.

Parameters:eventListBoxDragEvent

onDrop?

(event: ListBoxDragEvent) => void

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

Parameters:eventListBoxDragEvent

Fires when the user clicks an item of the ListBox. The event contains the clicked item.

Parameters:eventListBoxItemClickEvent

Fires when the user presses a key in the ListBox list. Use it to add extra keyboard navigation.

Parameters:eventListBoxKeyDownEvent

Sets the data item field that marks an item as selected. When the field value is true, the ListBox selects the item.

size?

"small" | "medium" | "large"

Sets the size of the ListBox.

The available options are:

  • small
  • medium
  • large
Default:

undefined

tabIndex?

number

Sets the tabindex attribute of the ListBox list.

textField

string

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

toolbar?

string | object | Function

Sets a toolbar that renders next to the ListBox. Accepts a Vue component, a render function, or a slot name.

Sets the position of the ListBox toolbar. The ListBox may have no toolbar.

The available options are:

  • top
  • bottom
  • left
  • right
  • none
Default:

right

Sets the data item field that the ListBox uses when you submit a form. When you do not set it, the ListBox uses textField.