ListBoxProps
Represents the props of the KendoReact ListBox component.
Definition
Package:@progress/kendo-react-listbox
Properties
className?
string
Sets a class of the ListBox container.
data
any[]
Sets the data of the ListBox.
draggable?
boolean
Makes the items of the ListBox draggable.
true
id?
string
Sets an id of the ListBox container.
item?
ComponentType<any>
Defines the component that will be rendered for each item of the data collection.
onDragLeave?
(event: ListBoxDragLeaveEvent) => void
Fires when a dragged element or text selection leaves the ListBox element.
onDragOver?
(event: ListBoxDragEvent) => void
Fires when the user drags over an item from the ListBox. The event contains information about the item that is dragged over.
onDragStart?
(event: ListBoxDragEvent) => void
Fires when the user starts to drag an item from the ListBox. The event contains information about the item that is being dragged.
onDrop?
(event: ListBoxDragEvent) => void
Fires when the user drops an item. The event contains information about the drop target item.
onItemClick?
(event: ListBoxItemClickEvent) => void
Fires when an item from the ListBox is clicked. Contains the clicked item.
onItemSelect?
(event: ListBoxItemSelectEvent) => void
Fires when an item from the ListBox is selected. Contains the selected item.
onKeyboardNavigate?
(event: ListBoxItemNavigateEvent) => void
Fires when a keyboard navigation action is triggered.
onKeyDown?
(event: ListBoxKeyDownEvent) => void
Fires on keydown over the ListBox list items. You can use it to add extra keyboard navigation options.
selectedField?
string
Sets the selected field of the ListBox. Based on the value of this field, an item is selected or not.
size?
"small" | "medium" | "large"
Configures the size of the ListBox.
The available options are:
- small
- medium
- large
undefined (theme-controlled)
style?
CSSProperties
Specifies the styles which are set to the ListBox container.
textField
string
Sets the data item field that represents the item text. If the data contains only primitive values, do not define it.
toolbar?
null | ComponentType<any>
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:
topbottomleftright(Default)none
'right'
valueField?
string
The field that is used during form submission. Defaults to the textField if not set.
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.