1.8 KiB
1.8 KiB
ScrollBar
A ScrollBar element that can be attached to other elements to control their scroll properties
Extends: VisualElement
Properties
| Property | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Current scroll value |
| min | number | 0 | Minimum scroll value |
| max | number | 100 | Maximum scroll value |
| step | number | 1 | Step size for scroll operations |
| dragMultiplier | number | 1 | How fast the ScrollBar moves when dragging |
| symbol | string | " | " Symbol used for the ScrollBar handle |
| backgroundSymbol | string | "\127" | Symbol used for the ScrollBar background |
| symbolBackgroundColor | color | black | Background color of the ScrollBar handle |
| backgroundSymbol | string | "\127" | Symbol used for the ScrollBar background |
| minValue | number | function | 0 |
| maxValue | number | function | 100 |
| orientation | string | vertical | Orientation of the ScrollBar ("vertical" or "horizontal") |
| handleSize | number | 2 | Size of the ScrollBar handle in characters |
Functions
| Method | Returns | Description |
|---|---|---|
| ScrollBar:attach | ScrollBar | Attaches the ScrollBar to an element's property |
| ScrollBar:updateAttachedElement | ScrollBar | Updates the attached element's property based on the ScrollBar value |
ScrollBar:attach(element, config)
Attaches the ScrollBar to an element's property
Parameters
elementBaseElementThe element to attach toconfigtableConfiguration {property = "propertyName", min = number|function, max = number|function}
Returns
ScrollBarselfThe ScrollBar instance
ScrollBar:updateAttachedElement()
Updates the attached element's property based on the ScrollBar value
Returns
ScrollBarselfThe ScrollBar instance