List ​

_This is the list class. It provides a scrollable list of selectable items with support for _ custom item rendering, separators, and selection handling.

Extends: VisualElement

Properties ​

Events ​

Functions ​

List:addItem(text) ​

Adds an item to the list

Parameters ​

• text string|table The item to add (string or item table)

Returns ​

• List self The List instance

Usage ​

list:addItem("New Item")
list:addItem({text="Item", callback=function() end})

list:addItem("New Item")
list:addItem({text="Item", callback=function() end})

List:removeItem(index) ​

Removes an item from the list

Parameters ​

• index number The index of the item to remove

Returns ​

• List self The List instance

Usage ​

list:removeItem(1)

list:removeItem(1)

List:clear() ​

Clears all items from the list

Returns ​

• List self The List instance

Usage ​

list:clear()

list:clear()

List:getSelectedItems() ​

Gets the currently selected items

Returns ​

• table selected List of selected items

Usage ​

local selected = list:getSelectedItems()

local selected = list:getSelectedItems()

List:getSelectedItem() ​

Gets first selected item

Returns ​

• selected The first item

List:onSelect(callback) ​

Registers a callback for the select event

Parameters ​

• callback function The callback function to register

Returns ​

• List self The List instance

Usage ​

list:onSelect(function(index, item) print("Selected item:", index, item) end)

list:onSelect(function(index, item) print("Selected item:", index, item) end)

List:scrollToBottom() ​

Scrolls the list to the bottom

Returns ​

• List self The List instance

List:scrollToTop() ​

Scrolls the list to the top

Returns ​

• List self The List instance