Basalt2/docs/references/elements/Scrollbar.md

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.new	ScrollBar	Creates a new ScrollBar instance
ScrollBar:init	ScrollBar	Initializes the ScrollBar instance
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:mouse_click	boolean	Handles mouse click events
ScrollBar:mouse_drag	boolean	Handles mouse drag events
ScrollBar:mouse_scroll	boolean	Handles mouse scroll events
ScrollBar:render	-	Renders the ScrollBar

ScrollBar.new()

Creates a new ScrollBar instance

Returns

• ScrollBar self The newly created ScrollBar instance

ScrollBar:init(props, basalt)

Parameters

• props table The properties to initialize the element with
• basalt table The basalt instance

Returns

• ScrollBar self The initialized instance

ScrollBar:attach(element, config)

Attaches the ScrollBar to an element's property

Parameters

• element BaseElement The element to attach to
• config table Configuration {property = "propertyName", min = number|function, max = number|function}

Returns

• ScrollBar self The ScrollBar instance

ScrollBar:updateAttachedElement()

Updates the attached element's property based on the ScrollBar value

Returns

• ScrollBar self The ScrollBar instance

ScrollBar:mouse_click(button, x, y)

Parameters

• button number The mouse button clicked
• x number The x position of the click
• y number The y position of the click

Returns

• boolean Whether the event was handled

ScrollBar:mouse_drag(button, x, y)

Parameters

• button number The mouse button being dragged
• x number The x position of the drag
• y number The y position of the drag

Returns

• boolean Whether the event was handled

ScrollBar:mouse_scroll(direction, x, y)

Parameters

• direction number The scroll direction (1 for up, -1 for down)
• x number The x position of the scroll
• y number The y position of the scroll

Returns

• boolean Whether the event was handled

ScrollBar:render()