Docs Update

src/elements/Dropdown.lua

@@ -2,15 +2,24 @@ local VisualElement = require("elements/VisualElement")
 local List = require("elements/List")
 local tHex = require("libraries/colorHex")
 
+--- This is the dropdown class. It is a visual element that can show a list of selectable items in a dropdown menu.
 ---@class Dropdown : List
 local Dropdown = setmetatable({}, List)
 Dropdown.__index = Dropdown
 
+---@property isOpen boolean false Whether the dropdown menu is currently open
 Dropdown.defineProperty(Dropdown, "isOpen", {default = false, type = "boolean", canTriggerRender = true})
+---@property dropdownHeight number 5 Maximum height of the dropdown menu when open
 Dropdown.defineProperty(Dropdown, "dropdownHeight", {default = 5, type = "number"})
+---@property selectedText string "" The text to show when no item is selected
 Dropdown.defineProperty(Dropdown, "selectedText", {default = "", type = "string"})
-Dropdown.defineProperty(Dropdown, "dropSymbol", {default = "\31", type = "string"})  -- ▼ Symbol
+---@property dropSymbol string "\31" The symbol to show for dropdown indication
+Dropdown.defineProperty(Dropdown, "dropSymbol", {default = "\31", type = "string"})
 
+--- Creates a new Dropdown instance
+--- @shortDescription Creates a new Dropdown instance
+--- @return Dropdown self The newly created Dropdown instance
+--- @usage local dropdown = Dropdown.new()
 function Dropdown.new()
     local self = setmetatable({}, Dropdown):__init()
     self.set("width", 16)
@@ -19,17 +28,29 @@ function Dropdown.new()
     return self
 end
 
+--- Initializes the Dropdown instance
+--- @shortDescription Initializes the Dropdown instance
+--- @param props table The properties to initialize the element with
+--- @param basalt table The basalt instance
+--- @return Dropdown self The initialized instance
 function Dropdown:init(props, basalt)
     List.init(self, props, basalt)
     self.set("type", "Dropdown")
+    return self
 end
 
+--- Handles mouse click events
+--- @shortDescription Handles mouse click events
+--- @param button number The button that was clicked
+--- @param x number The x position of the click
+--- @param y number The y position of the click
+--- @return boolean handled Whether the event was handled
 function Dropdown:mouse_click(button, x, y)
     if not VisualElement.mouse_click(self, button, x, y) then return false end
-    
+
     local relX, relY = self:getRelativePosition(x, y)
-    
-    if relY == 1 then  -- Klick auf Header
+
+    if relY == 1 then
         self.set("isOpen", not self.get("isOpen"))
         if not self.get("isOpen") then
             self.set("height", 1)
@@ -38,7 +59,6 @@ function Dropdown:mouse_click(button, x, y)
         end
         return true
     elseif self.get("isOpen") and relY > 1 then
-        -- Offset für die Liste korrigieren (relY - 1 wegen Header)
         local index = relY - 1 + self.get("offset")
         local items = self.get("items")
 
@@ -47,7 +67,7 @@ function Dropdown:mouse_click(button, x, y)
             if type(item) == "table" and item.separator then
                 return false
             end
-            
+
             self.set("selectedIndex", index)
             self.set("isOpen", false)
             self.set("height", 1)
@@ -63,30 +83,29 @@ function Dropdown:mouse_click(button, x, y)
     return false
 end
 
+--- Renders the Dropdown
+--- @shortDescription Renders the Dropdown
 function Dropdown:render()
     VisualElement.render(self)
-    
-    -- Header rendern
+
     local text = self.get("selectedText")
     if #text == 0 and self.get("selectedIndex") > 0 then
         local item = self.get("items")[self.get("selectedIndex")]
         text = type(item) == "table" and item.text or tostring(item)
     end
-    
+
     self:blit(1, 1, text .. string.rep(" ", self.get("width") - #text - 1) .. (self.get("isOpen") and "\31" or "\17"),
         string.rep(tHex[self.get("foreground")], self.get("width")),
         string.rep(tHex[self.get("background")], self.get("width")))
 
-    -- Items nur rendern wenn offen
     if self.get("isOpen") then
         local items = self.get("items")
         local offset = self.get("offset")
         local selected = self.get("selectedIndex")
         local width = self.get("width")
 
-        -- Liste ab Zeile 2 rendern (unterhalb des Headers)
         for i = 2, self.get("height") do
-            local itemIndex = i - 1 + offset  -- -1 wegen Header
+            local itemIndex = i - 1 + offset
             local item = items[itemIndex]
 
             if item then
@@ -101,7 +120,7 @@ function Dropdown:render()
                 else
                     local itemText = type(item) == "table" and item.text or tostring(item)
                     local isSelected = itemIndex == selected
-                    
+
                     local bg = isSelected and 
                         (item.selectedBackground or self.get("selectedColor")) or
                         (item.background or self.get("background"))