deploy: 1c90c6cf04

docs/references/elements/BaseFrame.md

@@ -1,65 +1,37 @@
-local elementManager = require("elementManager")
-local Container = elementManager.getElement("Container")
-local Render = require("render")
+# BaseFrame : Container
 
----@class BaseFrame : Container
-local BaseFrame = setmetatable({}, Container)
-BaseFrame.__index = BaseFrame
+## Properties
 
----@property text term term nil text
-BaseFrame.defineProperty(BaseFrame, "term", {default = nil, type = "table", setter = function(self, value)
-    if value == nil or value.setCursorPos == nil then
-        return value
-    end
-    self._render = Render.new(value)
-    self._renderUpdate = true
-    local width, height = value.getSize()
-    self.set("width", width)
-    self.set("height", height)
-    return value
-end})
+|Property|Type|Default|Description|
+|---|---|---|---|
+|text|term|term|nil text
 
-function BaseFrame.new()
-    local self = setmetatable({}, BaseFrame):__init()
-    self.set("term", term.current())
-    self.set("background", colors.lightGray)
-    return self
-end
+## Functions
 
-function BaseFrame:init(props, basalt)
-    Container.init(self, props, basalt)
-    self.set("type", "BaseFrame")
-end
+|Method|Returns|Description|
+|---|---|---|
+|[BaseFrame.new](#BaseFrame.new)|-|
+|[BaseFrame:blit](#BaseFrame:blit)|-|
+|[BaseFrame:init](#BaseFrame:init)|-|
+|[BaseFrame:multiBlit](#BaseFrame:multiBlit)|-|
+|[BaseFrame:render](#BaseFrame:render)|-|
+|[BaseFrame:setCursor](#BaseFrame:setCursor)|-|
+|[BaseFrame:textBg](#BaseFrame:textBg)|-|
+|[BaseFrame:textFg](#BaseFrame:textFg)|-|
 
-function BaseFrame:multiBlit(x, y, width, height, text, fg, bg)
-    self._render:multiBlit(x, y, width, height, text, fg, bg)
-end
+## BaseFrame.new()
 
-function BaseFrame:textFg(x, y, text, fg)
-    self._render:textFg(x, y, text, fg)
-end
+## BaseFrame:blit()
 
-function BaseFrame:textBg(x, y, text, bg)
-    self._render:textBg(x, y, text, bg)
-end
+## BaseFrame:init()
 
-function BaseFrame:blit(x, y, text, fg, bg)
-    self._render:blit(x, y, text, fg, bg)
-end
+## BaseFrame:multiBlit()
 
-function BaseFrame:setCursor(x, y, blink)
-    local term = self.get("term")
-    self._render:setCursor(x, y, blink)
-end
+## BaseFrame:render()
 
-function BaseFrame:render()
-    if(self._renderUpdate) then
-        if self._render ~= nil then
-            Container.render(self)
-            self._render:render()
-            self._renderUpdate = false
-        end
-    end
-end
+## BaseFrame:setCursor()
+
+## BaseFrame:textBg()
+
+## BaseFrame:textFg()
 
-return BaseFrame