Skip to content
Roblox API Reference

ScrollingFrame

ScrollingFrame is a special Frame type with built-in scrolling interactivity and different ways to customize how the scrolling works.
Memory category
Gui
Own members
32
Inherited members
156
Subclasses
0
Siblings
12

Properties106

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Inherited fromGuiBase2d17

Property categoryData

Property categoryDebugging

Property categoryLocalization

Property categorySelection

Inherited fromGuiObject39

Property categoryAppearance

Property categoryBehavior

  • Determines if descendant GuiObjects outside of the bounds of a parent GUI element should render.
    • Read capabilities: UI
  • Deprecated: This property is deprecated. Use UIDragDetector instead, as it supports more input types and can be better customized.
    Determines whether a GuiObject (and its descendants) can be dragged around the screen.
    • Deprecated
    • Read capabilities: UI

Property categoryData

Property categoryEventReplicator

Property categorySelection

Property categoryState

Defined byScrollingFrame27

Property categoryData

Property categoryDebugging

  • ScrollingFrame.HorizontalBarRect: Rect = Rect.new(0, 0, 0, 0)
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: UI
  • ScrollingFrame.MaxCanvasPosition: Vector2 = Vector2.zero
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: UI
  • ScrollingFrame.VerticalBarRect: Rect = Rect.new(0, 0, 0, 0)
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: UI

Property categoryScrolling

  • ScrollingFrame.AbsoluteCanvasSize: Vector2 = Vector2.zero
    The size of the area that is scrollable, in offsets.
    • Read only
    • Thread unsafe
    • Read capabilities: UI
    • Save only
  • ScrollingFrame.AbsoluteWindowSize: Vector2 = Vector2.zero
    The size of the frame, in offsets, without the scroll bars.
    • Read only
    • Thread unsafe
    • Read capabilities: UI
    • Save only
  • ScrollingFrame.AutomaticCanvasSize: Enum.AutomaticSize = Enum.AutomaticSize.None
    Determines whether ScrollingFrame.CanvasSize is resized based on child content.
    • Read capabilities: UI
  • ScrollingFrame.BottomImage: string = "rbxasset://textures/ui/Scroll/scroll-bottom.png"
    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).
    • Read capabilities: UI
  • ScrollingFrame.BottomImageContent: Content
    The Content-typed equivalent of BottomImage.
    • Read capabilities: UI
  • ScrollingFrame.CanvasPosition: Vector2 = Vector2.zero
    Reflects the current positional offset of the canvas within the frame, in pixels, and sets the position of scroll bars accordingly.
    • Read capabilities: UI
  • ScrollingFrame.CanvasSize: UDim2 = UDim2.new(0, 0, 2, 0)
    Determines the size of the scrollable area.
    • Read capabilities: UI
  • Determines if and when elastic scrolling is allowed on touch‑enabled devices.
    • Read capabilities: UI
  • ScrollingFrame.HorizontalScrollBarInset: Enum.ScrollBarInset = Enum.ScrollBarInset.None
    Indicates whether CanvasSize is inset by ScrollBarThickness on the horizontal axis.
    • Read capabilities: UI
  • ScrollingFrame.MidImage: string = "rbxasset://textures/ui/Scroll/scroll-middle.png"
    Image which spans the area between TopImage and BottomImage (rotated 90° counterclockwise for a horizontal scroll bar).
    • Read capabilities: UI
  • ScrollingFrame.MidImageContent: Content
    The Content-typed equivalent of MidImage.
    • Read capabilities: UI
  • ScrollingFrame.ScrollBarImageColor3: Color3 = Color3.new(1, 1, 1)
    Determines how the rendered scroll bar images are colorized.
    • Read capabilities: UI
  • ScrollingFrame.ScrollBarImageTransparency: number = 0
    Determines the opacity of the scroll bar images.
    • Read capabilities: UI
  • ScrollingFrame.ScrollBarThickness: number = 12
    Thickness of the scroll bar in pixels; applies to both horizontal and vertical scroll bars.
    • Read capabilities: UI
  • ScrollingFrame.ScrollingDirection: Enum.ScrollingDirection = Enum.ScrollingDirection.XY
    Determines the direction(s) in which scrolling is allowed.
    • Read capabilities: UI
  • ScrollingFrame.ScrollingEnabled: boolean = true
    Determines whether scrolling is allowed on the frame.
    • Read capabilities: UI
  • ScrollingFrame.ScrollRate: number = 1
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: UI
  • ScrollingFrame.ScrollVelocity: Vector2 = Vector2.zero
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: UI
  • ScrollingFrame.SmoothScroll: boolean = true
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: UI
  • ScrollingFrame.TopImage: string = "rbxasset://textures/ui/Scroll/scroll-top.png"
    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).
    • Read capabilities: UI
  • ScrollingFrame.TopImageContent: Content
    The Content-typed equivalent of TopImage.
    • Read capabilities: UI
  • ScrollingFrame.VerticalScrollBarInset: Enum.ScrollBarInset = Enum.ScrollBarInset.None
    Indicates whether CanvasSize is inset by ScrollBarThickness on the vertical axis.
    • Read capabilities: UI
  • ScrollingFrame.VerticalScrollBarPosition: Enum.VerticalScrollBarPosition = Enum.VerticalScrollBarPosition.Right
    Indicates whether the vertical scroll bar is positioned to the left or right of the canvas.
    • Read capabilities: UI

Methods53

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Inherited fromGuiObject6
Defined byScrollingFrame5
  • ScrollingFrame:ClearInertialScrolling()
    • Roblox script security
    • Capabilities: UI
  • ScrollingFrame:GetSampledInertialVelocity(): Vector2
    • Roblox script security
    • Capabilities: UI
    Returns
    Type
    Vector2
  • ScrollingFrame:GetScrollVelocity(): Vector2
    Returns a Vector2 representing the current inertial scroll velocity after the user stops their input.
    • Capabilities: UI
    Returns
    TypeDescription
    Vector2
    The current inertial scroll velocity in pixels per second on each axis, or (0, 0) if the frame is not coasting.
  • ScrollingFrame:ResetScrollVelocity()
    Resets the inertial scroll velocity of the ScrollingFrame to 0 on both axes.
    • Capabilities: UI
  • ScrollingFrame:ScrollToTop()
    • Roblox script security
    • Capabilities: UI

Events29

Inherited fromObject1
Inherited fromInstance9
Inherited fromGuiBase2d1
Inherited fromGuiObject18