Docs fix
This commit is contained in:
@@ -1,32 +1,45 @@
|
||||
# Label : VisualElement
|
||||
This is the label class. It provides a simple text display element that automatically
|
||||
resizes its width based on the text content.
|
||||
# Label
|
||||
_This is the label class. It provides a simple text display element that automatically
|
||||
resizes its width based on the text content._
|
||||
|
||||
Extends: `VisualElement`
|
||||
|
||||
## Properties
|
||||
|
||||
|Property|Type|Default|Description|
|
||||
|---|---|---|---|
|
||||
|text|string|Label|The text content to display. Can be a string or a function that returns a string
|
||||
|autoSize|boolean|true|Whether the label should automatically resize its width based on the text content
|
||||
|text|string|Label|The text content to display. Can be a string or a function that returns a string|
|
||||
|autoSize|boolean|true|Whether the label should automatically resize its width based on the text content|
|
||||
|
||||
## Functions
|
||||
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|[Label:getWrappedText](#label-getwrappedtext)|table|Gets the wrapped lines of the Label
|
||||
|[Label.new](#label-new)|Label|Creates a new Label instance|
|
||||
|[Label:Label](#label-label-props-basalt)|Label|Initializes the Label instance|
|
||||
|[Label:Label](#label-label)|table|Gets the wrapped lines of the Label|
|
||||
|[Label:Label](#label-label)|-|Renders the Label by drawing its text content|
|
||||
|
||||
## Label.new()
|
||||
|
||||
## Protected Functions
|
||||
Creates a new Label instance
|
||||
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|Label:init|Label|Initializes the Label instance
|
||||
|Label:render|-|Renders the Label by drawing its text content
|
||||
### Returns
|
||||
* `Label` `self` The newly created Label instance
|
||||
|
||||
## Label:Label(props, basalt)
|
||||
### Parameters
|
||||
* `props` `table` The properties to initialize the element with
|
||||
* `basalt` `table` The basalt instance
|
||||
|
||||
### Returns
|
||||
* `Label` `self` The initialized instance
|
||||
|
||||
## Label:Label()
|
||||
|
||||
## Label:getWrappedText()
|
||||
Gets the wrapped lines of the Label
|
||||
|
||||
### Returns
|
||||
* `table` `wrappedText` The wrapped lines of the Label
|
||||
|
||||
|
||||
## Label:Label()
|
||||
Reference in New Issue
Block a user