ScrollingFrame
Up and coming: shot check knows this class and its members today, and programs run it once the native runtime lands.
Up and coming
A view onto content bigger than its box that scrolls smoothly, with thin overlay scroll bars and a mode that sticks to the end.
Setting CanvasPosition glides there, the wheel glides, and dragging the bar follows the pointer 1:1 and throws on release. Your layout sets CanvasSize. StickToEnd keeps growing content in view at the bottom until you scroll up. For long lists, VisibleRect says what is in view, so you can build one row more than fits and rebind rows as it scrolls.
Made with Instance.new("ScrollingFrame") or Clone().
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| CanvasSize | UDim2 | The content's size; your scripted layout sets it. | |
| CanvasPosition | Vector2 | Setting it glides there; the wheel glides too, and dragging the bar is 1:1 and throws on release. | |
| ScrollingDirection | "Y" | "X" | "XY" | ||
| ScrollBarVisibility | "Auto" | "Always" | "Never" | Auto shows thin overlay bars that fade in while scrolling or hovered. | |
| ScrollBarThickness | number | ||
| StickToEnd | boolean | At the bottom, growing content keeps it at the bottom; scrolled up, it stays where you left it. | |
| VisibleRect | Rect | read-only | The part of the canvas in view, for pooling rows: build one more than fits and rebind them on scroll. |
Methods
| Name | Arguments | Returns | Description |
|---|---|---|---|
| ScrollTo | (position: Vector2) | () | Glides to the position. |
| ScrollIntoView | (child: UIObject) | () |
Events
| Name | Passes | Description |
|---|---|---|
| CanvasPositionChanged | (Vector2) |
From Frame 10
From UIObject 19
From ScreenItem 2
From ShotInstance 33
ClassNameNameParentAncestryChangedAttributeChangedChangedChildAddedChildRemovedDestroyingAddTagClearAllChildrenCloneDestroyFindFirstAncestorFindFirstAncestorOfClassFindFirstAncestorWhichIsAFindFirstChildFindFirstChildOfClassFindFirstChildWhichIsAGetAttributeGetAttributeChangedSignalGetAttributesGetChildrenGetDescendantsGetFullNameGetPropertyChangedSignalGetTagsHasTagIsAIsAncestorOfIsDescendantOfRemoveTagSetAttribute