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

ListBoxComponent

Represents the Kendo UI ListBox component for Angular.

Selector

kendo-listbox

Inputs

NameTypeDefaultDescription

data

any[]

The data which will be displayed by the ListBox.

itemDisabled

(item: any) => boolean

A function which determines if a specific item is disabled.

listboxLabel

string

The value of the aria-label attribute of the Listbox element.

listboxToolbarLabel

string

The value of the aria-label attribute of the Listbox toolbar element.

size

ListBoxSize

Sets the size of the component.

The possible values are:

  • 'small'
  • 'medium' (default)
  • 'large'

textField

string

The fields of the data item that provide the text content of the nodes.

toolbar

ListBoxToolbarConfig

Sets whether a toolbar should be displayed with the ListBox, as well as what tools and position should be used.

Fields

NameTypeDefaultDescription

selectedIndex

number

The index of the currently selected item in the ListBox.

Events

NameTypeDescription

actionClick

EventEmitter<ActionName>

Fires when the user clicks a ListBox item.

selectionChange

EventEmitter<ListBoxSelectionEvent>

Fires when the user selects a different ListBox item. Also fires when a node is moved, since that also changes its index.

Methods

clearSelection

Programmatically clears the ListBox selection.

selectItem

Programmatically selects a ListBox node.

Parameters

index

number