Files
Basalt2/docs/references/elements/Dropdown.md
2025-02-18 08:47:22 +00:00

1.5 KiB

Dropdown : List

This is the dropdown class. It is a visual element that can show a list of selectable items in a dropdown menu.

Properties

Property Type Default Description
isOpen boolean false Whether the dropdown menu is currently open
dropdownHeight number 5 Maximum height of the dropdown menu when open
selectedText string "" The text to show when no item is selected
dropSymbol string "\31" The symbol to show for dropdown indication

Functions

Method Returns Description
Dropdown.new Dropdown Creates a new Dropdown instance
Dropdown:init Dropdown Initializes the Dropdown instance
Dropdown:mouse_click boolean Handles mouse click events
Dropdown:render - Renders the Dropdown

Dropdown.new()

Creates a new Dropdown instance

Returns

  • Dropdown self The newly created Dropdown instance

Usage

local dropdown = Dropdown.new()

Dropdown:init(props, basalt)

Initializes the Dropdown instance

Parameters

  • props table The properties to initialize the element with
  • basalt table The basalt instance

Returns

  • Dropdown self The initialized instance

Dropdown:mouse_click(button, x, y)

Handles mouse click events

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 handled Whether the event was handled

Dropdown:render()

Renders the Dropdown