deploy: 487409b31a
This commit is contained in:
@@ -1,48 +0,0 @@
|
||||
# Slider : VisualElement
|
||||
This is the slider class. It provides a draggable slider control that can be either horizontal or vertical,
|
||||
with customizable colors and value ranges.
|
||||
|
||||
## Properties
|
||||
|
||||
|Property|Type|Default|Description|
|
||||
|---|---|---|---|
|
||||
|step|number|1|Current position of the slider handle (1 to width/height)
|
||||
|max|number|100|Maximum value for value conversion (maps slider position to this range)
|
||||
|horizontal|boolean|true|Whether the slider is horizontal (false for vertical)
|
||||
|barColor|color|gray|Color of the slider track
|
||||
|sliderColor|color|blue|Color of the slider handle
|
||||
|
||||
## Events
|
||||
|
||||
|Event|Parameters|Description|
|
||||
|---|---|---|
|
||||
|onChange|`value number`|Fired when the slider value changes|
|
||||
|
||||
## Functions
|
||||
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|[Slider:getValue](#slider-getvalue)|number|Gets the current value mapped to the max range
|
||||
|
||||
|
||||
## Protected Functions
|
||||
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|Slider:init|Slider|Initializes the Slider instance
|
||||
|Slider:mouse_click|boolean|Updates slider position on mouse click
|
||||
|Slider:mouse_scroll|boolean|Handles mouse release events
|
||||
|Slider:render|-|Renders the slider with track and handle
|
||||
|
||||
## Slider:getValue()
|
||||
Gets the current value of the slider
|
||||
|
||||
### Returns
|
||||
* `number` `value` The current value (0 to max)
|
||||
|
||||
### Usage
|
||||
```lua
|
||||
local value = slider:getValue()
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user