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

49
docs/references/elements/Menu.md
View File

@@ -1,61 +1,40 @@
# Menu
_This is the menu class. It provides a horizontal menu bar with selectable items.
Menu items are displayed in a single row and can have custom colors and callbacks._
Extends: `List`
# Menu : List
This is the menu class. It provides a horizontal menu bar with selectable items.
Menu items are displayed in a single row and can have custom colors and callbacks.
## Properties
|Property|Type|Default|Description|
|---|---|---|---|
|separatorColor|color|gray|The color used for separator items in the menu|
|separatorColor|color|gray|The color used for separator items in the menu
## Functions
|Method|Returns|Description|
|---|---|---|
|[Menu.new](#menu-new)|Menu|Creates a new Menu instance|
|[Menu:Menu](#menu-menu-props-basalt)|Menu|Initializes the Menu instance|
|[Menu:Menu](#menu-menu-items)|Menu|Sets the menu items and calculates total width|
|[Menu:Menu](#menu-menu)|-|Renders the menu horizontally with proper spacing and colors|
|[Menu:Menu](#menu-menu-button-x-y)|boolean|Handles mouse click events and item selection|
|[Menu:setItems](#menu-setitems)|Menu|Sets the menu items and calculates total width
## Menu.new()
Creates a new Menu instance
## Protected Functions
### Returns
* `Menu` `self` The newly created Menu instance
## Menu:Menu(props, basalt)
### Parameters
* `props` `table` The properties to initialize the element with
* `basalt` `table` The basalt instance
### Returns
* `Menu` `self` The initialized instance
## Menu:Menu(items)
|Method|Returns|Description|
|---|---|---|
|Menu:init|Menu|Initializes the Menu instance
|Menu:mouse_click|boolean|Handles mouse click events and item selection
|Menu:render|-|Renders the menu horizontally with proper spacing and colors
## Menu:setItems(items)
Sets the menu items
### Parameters
* `items` `table` [] List of items with {text, separator, callback, foreground, background} properties
* `items` `table[]` List of items with {text, separator, callback, foreground, background} properties
### Returns
* `Menu` `self` The Menu instance
### Usage
```lua
```lua
menu:setItems({{text="File"}, {separator=true}, {text="Edit"}})
```
## Menu:Menu()
## Menu:Menu(button, x, y)
### Parameters
* `button` `number` The button that was clicked
* `x` `number` The x position of the click
* `y` `number` The y position of the click
### Returns
* `boolean` `Whether` the event was handled