Skip to Content
Kinemium

UIListLayout

Stack GUI children in a row or column.

UIListLayout arranges the children of a GUI object one after another in a single line. Padding, wrapping, flex alignment, and sort order control the result.

Getting started

local list = Instance.new("UIListLayout")
list.FillDirection = Enum.FillDirection.Vertical
list.Padding = UDim.new(0, 6)
list.SortOrder = Enum.SortOrder.LayoutOrder
list.Parent = frame

Properties

PropertyTypeAccessDescription
EnabledbooleanRead/writeWhether the layout runs.
FillDirectionEnum.FillDirectionRead/writeRow or column direction.
PaddingUDimRead/writeSpace between items.
SortOrderEnum.SortOrderRead/writeOrder used to sort children.
HorizontalAlignmentEnum.HorizontalAlignmentRead/writeHorizontal placement.
VerticalAlignmentEnum.VerticalAlignmentRead/writeVertical placement.
WrapsbooleanRead/writeWrap items onto a new line when full.
MaxItemsPerLinenumberRead/writeItems per line before wrapping.
LinePaddingUDimRead/writeSpace between wrapped lines.
ReversebooleanRead/writeReverse the item order.
IgnoreInvisiblebooleanRead/writeSkip invisible children.
HorizontalFlexEnum.UIFlexAlignmentRead/writeHow items distribute on the horizontal axis.
VerticalFlexEnum.UIFlexAlignmentRead/writeHow items distribute on the vertical axis.
ItemLineAlignmentEnum.ItemLineAlignmentRead/writeAlignment of items within a wrapped line.
PaddingLeftUDimRead/writePer-side padding.

Per-side padding properties mirror Padding for edges the layout needs.

Notes

  • Wraps requires a line limit or a container size to determine when to break.
  • MaxItemsPerLine only applies when wrapping is enabled.
  • IgnoreInvisible skips children whose Visible is false.
  • The layout doesn't resize the parent container.
  • Cloning copies the layout settings.

See also

  • UIGridLayout for a two-dimensional arrangement.
  • UIPadding for insets around the list.
  • GuiObject for the parent container.

On this page