New to Kendo UI for VueStart 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 class of the Tooltip animation container.

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.

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

Parameters:eventListBoxDragLeaveEvent

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

Parameters:eventListBoxDragEvent

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

Parameters:eventListBoxDragEvent

onDrop?

(event: ListBoxDragEvent) => void

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

Parameters:eventListBoxDragEvent

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

Parameters:eventListBoxItemClickEvent

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

Parameters:eventListBoxKeyDownEvent

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

size?

"small" | "medium" | "large"

Configures the size of the ListBox.

The available options are:

  • small
  • medium
  • large
Default:

undefined

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.

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

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