Skip to content
luxe API

luxe: ui/list.control

Data

Section titled “Data”
import "luxe: ui/list.control" for Data

no docs found

UIList

Section titled “UIList”
import "luxe: ui/list.control" for UIList

no docs found

UIList.create(.)

Section titled “UIList.create(.)”
UIList.create(ui_entity : Entity) : Control

Create a list control

UIList.add(..)

Section titled “UIList.add(..)”
UIList.add(list : Control, control : Control) : None

Add a given control to the list

UIList.remove(..)

Section titled “UIList.remove(..)”
UIList.remove(list : Control, control : Control) : None

Remove a given control from the list

UIList.clear(..)

Section titled “UIList.clear(..)”
UIList.clear(list : Control, action : UIClearAction) : None

Clear the list, with the given action to do with the removed controls

UIList.refresh(.)

Section titled “UIList.refresh(.)”
UIList.refresh(list : Control) : None

Refresh the list, called after changes (is this still needed?)

UIList.set_flex_width(..)

Section titled “UIList.set_flex_width(..)”
UIList.set_flex_width(list : Control, state : Bool) : None

Sets whether the control will expand to fill horizontal space. Typically you want this in flex layout.

UIList.set_percent(…)

Section titled “UIList.set_percent(…)”
UIList.set_percent(list : Control, vertical : Num, horizontal : Num) : unknown

Sets the amount of scroll in relative percent, 0…1

UIList.set_percent_v(..)

Section titled “UIList.set_percent_v(..)”
UIList.set_percent_v(list : Control, vertical : Num) : unknown

Sets the vertical amount of scroll in relative percent, 0…1

UIList.set_percent_h(..)

Section titled “UIList.set_percent_h(..)”
UIList.set_percent_h(list : Control, horizontal : Num) : unknown

Sets the horizontal amount of scroll in relative percent, 0…1

UIList.get_percent_v(.)

Section titled “UIList.get_percent_v(.)”
UIList.get_percent_v(list : Control) : Num

Returns the vertical amount of scroll in relative percent, 0…1

UIList.get_percent_h(.)

Section titled “UIList.get_percent_h(.)”
UIList.get_percent_h(list : Control) : Num

Returns the horizontal amount of scroll in relative percent, 0…1

UIList.set_scroll(…)

Section titled “UIList.set_scroll(…)”
UIList.set_scroll(list : Control, vertical : Num, horizontal : Num) : None

Returns the amount of scroll in absolute units

UIList.set_scroll_v(..)

Section titled “UIList.set_scroll_v(..)”
UIList.set_scroll_v(list : Control, vertical : Num) : None

Sets the vertical amount of scroll in absolute units

UIList.set_scroll_h(..)

Section titled “UIList.set_scroll_h(..)”
UIList.set_scroll_h(list : Control, horizontal : Num) : None

Sets the horizontal amount of scroll in absolute units

UIList.get_scroll_v(.)

Section titled “UIList.get_scroll_v(.)”
UIList.get_scroll_v(list : Control) : Num

Returns the vertical amount of scroll in absolute units

UIList.get_scroll_h(.)

Section titled “UIList.get_scroll_h(.)”
UIList.get_scroll_h(list : Control) : Num

Returns the horizontal amount of scroll in absolute units

UIList.can_scroll_v(.)

Section titled “UIList.can_scroll_v(.)”
UIList.can_scroll_v(list : Control) : Bool

Returns true if there’s any space to scroll vertically

UIList.can_scroll_h(.)

Section titled “UIList.can_scroll_h(.)”
UIList.can_scroll_h(list : Control) : Bool

Returns true if there’s any space to scroll horizontally

UIList.count(.)

Section titled “UIList.count(.)”
UIList.count(list : Control) : Num

Get the number of controls in the list

UIList.get(..)

Section titled “UIList.get(..)”
UIList.get(list : Control, index : Num) : Control

Get the control at the given index inside the list

UIList.index(..)

Section titled “UIList.index(..)”
UIList.index(list : Control, control : Control) : Num

Get the index of the given control inside the list