ScrollingFrame¶
ScrollingFrame is a special Frame type with built-in scrolling
interactivity and different ways to customize how the scrolling works.
Description¶
ScrollingFrame is a special Frame type with built-in scrolling
interactivity and different ways to customize how the scrolling works.
Inheritance¶
Object → Instance → GuiBase → GuiBase2d → GuiObject → ScrollingFrame
Nova inheritance: Instance → GuiBase → GuiBase2d → GuiObject → ScrollingFrame
Properties¶
AbsoluteWindowSize Supported Property The size of the frame, in offsets, without the scroll bars.
The size of the frame, in offsets, without the scroll bars. This read-only
property represents the visible content area of the ScrollingFrame: the
frame's AbsoluteSize minus the space
occupied by any currently visible scroll bar gutters
(ScrollBarThickness). If no
scroll bars are visible, this equals the frame's absolute size.
AutomaticCanvasSize Supported Property Determines whether ScrollingFrame.CanvasSize is resized based on child content.
Determines whether ScrollingFrame.CanvasSize is resized based on child content.
This property is used to automatically size parent UI objects based on the
size of its descendants. You can use this property to dynamically add text
and other content to a ScrollingFrame at edit or run time and the size
will adjust to fit that content.
When this property is set to an AutomaticSize value other than None, AbsoluteCanvasSize may resize depending on its child content.
BottomImage Supported Property Image that displays on the bottom of a vertical scroll bar, or the right of a horizontal scroll bar (rotated 90° counterclockwise for a horizonta…
Image that displays on the bottom of a vertical scroll bar, or the right of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar).
CanvasPosition Supported Property Reflects the current positional offset of the canvas within the frame, in pixels, and sets the position of scroll bars accordingly.
Reflects the current positional offset of the canvas within the frame, in pixels, and sets the position of scroll bars accordingly. Note that this property doesn't do anything if scroll bars aren't visible.
CanvasSize Supported Property Determines the size of the scrollable area.
Determines the size of the scrollable area. For an adaptive alternative
based on the overall size of children within the ScrollingFrame,
consider using
AutomaticCanvasSize.
ElasticBehavior Supported Property Determines if and when elastic scrolling is allowed on touch‑enabled devices.
This property determines if and when elastic scrolling is allowed on touch‑enabled devices. Defaults to WhenScrollable.
HorizontalScrollBarInset Supported Property Indicates whether CanvasSize is inset by ScrollBarThickness on the horizontal axis.
Indicates whether CanvasSize is inset by ScrollBarThickness on the horizontal axis.
Indicates whether the scrollable canvas is inset by ScrollBarThickness to account for the horizontal scroll bar. Because the horizontal scroll bar occupies space along the bottom edge, this inset reduces the canvas height. Defaults to ScrollBarInset.None.
MidImage Supported Property Image which spans the area between TopImage and BottomImage (rotated 90° counterclockwise for a horizontal scroll bar).
Image which spans the area between TopImage and BottomImage (rotated 90° counterclockwise for a horizontal scroll bar). This image automatically scales to fill the space between the cap segments.
ScrollBarImageColor3 Supported Property Determines how the rendered scroll bar images are colorized.
Determines how the rendered scroll bar images are colorized.
Determines how the scroll bar images (TopImage, MidImage, BottomImage) are colorized. When set to white, no colorization occurs. This property is useful for reusing image assets; if the source images are completely white with transparency, you can set the color of the entire scroll bar at once.
ScrollBarImageTransparency Supported Property Determines the opacity of the scroll bar images.
Determines the opacity of the scroll bar images.
Determines the opacity of the scroll bar images
(TopImage,
MidImage,
BottomImage). A value of 0 is
completely opaque and a value of 1 is completely transparent
(invisible).
ScrollBarThickness Supported Property Thickness of the scroll bar in pixels; applies to both horizontal and vertical scroll bars.
Thickness of the scroll bar in pixels; applies to both horizontal and
vertical scroll bars. If set to 0, no scroll bars are rendered.
ScrollingDirection Supported Property Determines the direction(s) in which scrolling is allowed.
This property determines the direction(s) in which scrolling is allowed. If scrolling is disallowed in a direction, the associated scroll bar will not appear. Defaults to ScrollingDirection.XY.
ScrollingEnabled Supported Property Determines whether scrolling is allowed on the frame.
Determines whether scrolling is allowed on the frame. If false, no
scroll bars will be rendered.
TopImage Supported Property Image which displays on the top of a vertical scroll bar, or the left of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal s…
Image which displays on the top of a vertical scroll bar, or the left of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar).
VerticalScrollBarInset Supported Property Indicates whether CanvasSize is inset by ScrollBarThickness on the vertical axis.
Indicates whether CanvasSize is inset by ScrollBarThickness on the vertical axis.
Indicates whether the scrollable canvas is inset by ScrollBarThickness to account for the vertical scroll bar. Because the vertical scroll bar occupies space along a side edge, this inset reduces the canvas width. Defaults to ScrollBarInset.None.
VerticalScrollBarPosition Supported Property Indicates whether the vertical scroll bar is positioned to the left or right of the canvas.
Indicates whether the vertical scroll bar is positioned to the left or right of the canvas. Defaults to VerticalScrollBarPosition.Right.
Inherited members¶
Inherited from GuiObject: 45 properties, 39 methods, 25 events. They are documented on the base class page.
9 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's ScrollingFrame class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AbsoluteCanvasSize |
AbsoluteCanvasSize: Vector2 |
Not yet | The size of the area that is scrollable, in offsets. | ReadOnly, NotReplicated |
BottomImageContent |
BottomImageContent: Content |
Not yet | The Content-typed equivalent of BottomImage. | — |
MidImageContent |
MidImageContent: Content |
Not yet | The Content-typed equivalent of MidImage. | — |
TopImageContent |
TopImageContent: Content |
Not yet | The Content-typed equivalent of TopImage. | — |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
ClearInertialScrolling |
ScrollingFrame:ClearInertialScrolling(): null |
Not yet | — | RobloxScriptSecurity |
GetSampledInertialVelocity |
ScrollingFrame:GetSampledInertialVelocity(): Vector2 |
Not yet | — | RobloxScriptSecurity |
GetScrollVelocity |
ScrollingFrame:GetScrollVelocity(): Vector2 |
Not yet | Returns a Vector2 representing the current inertial scroll velocity after the user stops their input. | — |
ResetScrollVelocity |
ScrollingFrame:ResetScrollVelocity(): null |
Not yet | Resets the inertial scroll velocity of the ScrollingFrame to 0 on both axes. |
— |
ScrollToTop |
ScrollingFrame:ScrollToTop(): null |
Not yet | — | RobloxScriptSecurity |
Roblox reference: ScrollingFrame
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.