GitHub/Basalt2
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs fix

Browse Source
This commit is contained in:
Robert Jelic
2025-09-13 12:54:15 +02:00
parent 3504d8a3aa 8e64ba97bf
commit 9e1112f3bd
42 changed files with 1582 additions and 2507 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
docs/references/elements/List.md
View File

@@ -1,19 +1,17 @@
# 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`
# List : VisualElement
This is the list class. It provides a scrollable list of selectable items with support for
custom item rendering, separators, and selection handling.
## Properties
|Property|Type|Default|Description|
|---|---|---|---|
|items|table|{}|List of items to display. Items can be tables with properties including selected state|
|selectable|boolean|true|Whether items in the list can be selected|
|multiSelection|boolean|false|Whether multiple items can be selected at once|
|offset|number|0|Current scroll offset for viewing long lists|
|selectedBackground|color|blue|Background color for selected items|
|selectedForeground|color|white|Text color for selected items|
|items|table|{}|List of items to display. Items can be tables with properties including selected state
|selectable|boolean|true|Whether items in the list can be selected
|multiSelection|boolean|false|Whether multiple items can be selected at once
|offset|number|0|Current scroll offset for viewing long lists
|selectedBackground|color|blue|Background color for selected items
|selectedForeground|color|white|Text color for selected items
## Events
@@ -25,37 +23,26 @@ Extends: `VisualElement`
|Method|Returns|Description|
|---|---|---|
|[List.new](#list-new)|List|Creates a new List instance|
|[List:List](#list-list-props-basalt)|List|Initializes the List instance|
|[List:List](#list-list-text)|List|Adds an item to the list|
|[List:List](#list-list-index)|List|Removes an item from the list|
|[List:List](#list-list)|List|Clears all items from the list|
|[List:List](#list-list)|table|Gets the currently selected items|
|[List:List](#list-list)|selected|Gets first selected item|
|[List:List](#list-list-button-x-y)|boolean|Handles mouse click events|
|[List:List](#list-list-direction-x-y)|boolean|Handles mouse scroll events|
|[List:List](#list-list-callback)|List|Registers a callback for the select event|
|[List:List](#list-list)|List|Scrolls the list to the bottom|
|[List:List](#list-list)|List|Scrolls the list to the top|
|[List:List](#list-list)|-|Renders the list|
|[List:addItem](#list-additem)|List|Adds an item to the list
|[List:clear](#list-clear)|List|Clears all items from the list
|[List:getSelectedItem](#list-getselecteditem)|table?|Gets first selected item
|[List:getSelectedItems](#list-getselecteditems)|table|Gets the currently selected items
|[List:onSelect](#list-onselect)|List|Registers a callback for the select event
|[List:removeItem](#list-removeitem)|List|Removes an item from the list
|[List:scrollToBottom](#list-scrolltobottom)|List|Scrolls the list to the bottom
|[List:scrollToTop](#list-scrolltotop)|List|Scrolls the list to the top
## List.new()
Creates a new List instance
## Protected Functions
### Returns
* `List` `self` The newly created List instance
## List:List(props, basalt)
### Parameters
* `props` `table` The properties to initialize the element with
* `basalt` `table` The basalt instance
### Returns
* `List` `self` The initialized instance
## List:List(text)
|Method|Returns|Description|
|---|---|---|
|List:init|List|Initializes the List instance
|List:mouse_click|boolean|Handles mouse click events
|List:mouse_scroll|boolean|Handles mouse scroll events
|List:render|-|Renders the list
## List:addItem(text)
Adds an item to the list
### Parameters
@@ -65,77 +52,40 @@ Adds an item to the list
* `List` `self` The List instance
### Usage
```lua
```lua
list:addItem("New Item")
list:addItem({text="Item", callback=function() end})
```
## List:List(index)
Removes an item from the list
### Parameters
* `index` `number` The index of the item to remove
### Returns
* `List` `self` The List instance
### Usage
```lua
list:removeItem(1)
```
## List:List()
## List:clear()
Clears all items from the list
### Returns
* `List` `self` The List instance
### Usage
```lua
```lua
list:clear()
```
## List:List()
## List:getSelectedItem()
Gets first selected item
### Returns
* `table?` `selected` The first item
## List:getSelectedItems()
Gets the currently selected items
### Returns
* `table` `selected` List of selected items
### Usage
```lua
```lua
local selected = list:getSelectedItems()
```
## List:List()
Gets first selected item
### Returns
* `selected` `The` first item
## List:List(button, x, y)
### Parameters
* `button` `number` The mouse button that was clicked
* `x` `number` The x-coordinate of the click
* `y` `number` The y-coordinate of the click
### Returns
* `boolean` `Whether` the event was handled
## List:List(direction, x, y)
### Parameters
* `direction` `number` The direction of the scroll (1 for down, -1 for up)
* `x` `number` The x-coordinate of the scroll
* `y` `number` The y-coordinate of the scroll
### Returns
* `boolean` `Whether` the event was handled
## List:List(callback)
## List:onSelect(callback)
Registers a callback for the select event
### Parameters
@@ -145,22 +95,34 @@ Registers a callback for the select event
* `List` `self` The List instance
### Usage
```lua
```lua
list:onSelect(function(index, item) print("Selected item:", index, item) end)
```
## List:List()
## 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
```lua
list:removeItem(1)
```
## List:scrollToBottom()
Scrolls the list to the bottom
### Returns
* `List` `self` The List instance
## List:List()
## List:scrollToTop()
Scrolls the list to the top
### Returns
* `List` `self` The List instance
## List:List()