Basalt2/docs/references/elements/List.md

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: Collection

Properties

Property	Type	Default	Description
offset	number	0	Current scroll offset for viewing long lists
emptyText	string	"No	items" Text to display when the list is empty
showScrollBar	boolean	true	Whether to show the scrollbar when items exceed height
scrollBarSymbol	string	"	" Symbol used for the scrollbar handle
scrollBarBackground	string	"\127"	Symbol used for the scrollbar background
scrollBarColor	color	lightGray	Color of the scrollbar handle
scrollBarBackgroundColor	color	gray	Background color of the scrollbar

Events

Event	Parameters	Description
onSelect	index number, item table	Fired when an item is selected

Functions

Method	Returns	Description
List:onSelect	List	Registers a callback for the select event
List:scrollToBottom	List	Scrolls the list to the bottom
List:scrollToTop	List	Scrolls the list to the top
List:scrollToItem	List	Scrolls to a specific 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: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

List:scrollToItem(index)

Scrolls to make a specific item visible

Parameters

• index number The index of the item to scroll to

Returns

• List self The List instance

Usage

list:scrollToItem(5)