# This file is automatically generated. Please don't edit it manually. # To submit a bug report on the content, see # https://devforum.roblox.com/c/bug-reports/documentation-issues/72 name: ScrollingFrame type: class memory_category: Gui summary: | `ScrollingFrame` is a special `Class.Frame` type with built-in scrolling interactivity and different ways to customize how the scrolling works. description: | `ScrollingFrame` is a special `Class.Frame` type with built-in scrolling interactivity and different ways to customize how the scrolling works. Example ScrollingFrame on the screen containing a tabbed category bar and a list of magical items for the player to consider purchasing. code_samples: [] inherits: - GuiObject descendants: [] tags: [] deprecation_message: '' properties: - name: ScrollingFrame.AbsoluteCanvasSize summary: | The size of the area that is scrollable, in offsets. description: | The size of the area that is scrollable, in offsets. This property is set to the maximum of the `Class.ScrollingFrame.CanvasSize|CanvasSize` property and the size of the children if `Class.ScrollingFrame.AutomaticCanvasSize|AutomaticCanvasSize` is set to something other than `Enum.AutomaticSize.None`. code_samples: [] type: Vector2 tags: - ReadOnly - NotReplicated deprecation_message: '' security: read: None write: None thread_safety: Unsafe category: Scrolling serialization: can_load: false can_save: true capabilities: - UI - name: ScrollingFrame.AbsoluteWindowSize summary: | The size of the frame, in offsets, without the scroll bars. description: | The size of the frame, in offsets, without the scroll bars. code_samples: [] type: Vector2 tags: - ReadOnly - NotReplicated deprecation_message: '' security: read: None write: None thread_safety: Unsafe category: Scrolling serialization: can_load: false can_save: true capabilities: - UI - name: ScrollingFrame.AutomaticCanvasSize summary: | Determines whether `Class.ScrollingFrame.CanvasSize` is resized based on child content. description: | 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 `Enum.AutomaticSize` value other than `Enum.AutomaticSize|None`, `Class.ScrollingFrame.AbsoluteCanvasSize|AbsoluteCanvasSize` may resize depending on its child content. code_samples: [] type: AutomaticSize tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.BottomImage summary: | 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). description: | 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). Diagram showing the three image asset elements which construct a scrolling frame's scroll bar. code_samples: [] type: ContentId tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.BottomImageContent summary: | 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). Only supports asset URIs as textures. description: | 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). Diagram showing the three image asset elements which construct a scrolling frame's scroll bar. code_samples: [] type: Content tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.CanvasPosition summary: | Reflects the **current** positional offset of the canvas within the frame, in pixels, and sets the position of scroll bars accordingly. description: | 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. code_samples: [] type: Vector2 tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.CanvasSize summary: | Determines the size of the scrollable area. description: | Determines the size of the scrollable area. For an adaptive alternative based on the overall size of children within the `ScrollingFrame`, consider using `Class.ScrollingFrame.AutomaticCanvasSize|AutomaticCanvasSize`. code_samples: [] type: UDim2 tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.ElasticBehavior summary: | Determines if and when elastic scrolling is allowed on touch‑enabled devices. description: | This property determines if and when elastic scrolling is allowed on touch‑enabled devices. Defaults to `Enum.ElasticBehavior|WhenScrollable`. code_samples: [] type: ElasticBehavior tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.HorizontalScrollBarInset summary: | Indicates whether `Class.ScrollingFrame.CanvasSize|CanvasSize` is inset by `Class.ScrollingFrame.ScrollBarThickness|ScrollBarThickness` on the horizontal axis. description: | Indicates whether `Class.ScrollingFrame.CanvasSize|CanvasSize` is inset by `Class.ScrollingFrame.ScrollBarThickness|ScrollBarThickness` on the horizontal axis. code_samples: [] type: ScrollBarInset tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.MidImage summary: | Image which spans the area between `Class.ScrollingFrame.TopImage|TopImage` and `Class.ScrollingFrame.BottomImage|BottomImage` (rotated 90° counterclockwise for a horizontal scroll bar). description: | Image which spans the area between `Class.ScrollingFrame.TopImage|TopImage` and `Class.ScrollingFrame.BottomImage|BottomImage` (rotated 90° counterclockwise for a horizontal scroll bar). This image automatically scales to fill the space between the cap segments. Diagram showing the three image asset elements which construct a scrolling frame's scroll bar. code_samples: [] type: ContentId tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.MidImageContent summary: | Image which spans the area between `Class.ScrollingFrame.TopImageContent|TopImageContent` and `Class.ScrollingFrame.BottomImageContent|BottomImageContent` (rotated 90° counterclockwise for a horizontal scroll bar). Only supports asset URIs as textures. description: | Image which spans the area between `Class.ScrollingFrame.TopImage|TopImage` and `Class.ScrollingFrame.BottomImage|BottomImage` (rotated 90° counterclockwise for a horizontal scroll bar). This image automatically scales to fill the space between the cap segments. Diagram showing the three image asset elements which construct a scrolling frame's scroll bar. code_samples: [] type: Content tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.ScrollBarImageColor3 summary: | Determines how the rendered scroll bar images are colorized. description: | Determines how the scroll bar images (`Class.ScrollingFrame.TopImage|TopImage`, `Class.ScrollingFrame.MidImage|MidImage`, `Class.ScrollingFrame.BottomImage|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. code_samples: [] type: Color3 tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.ScrollBarImageTransparency summary: | Determines the opacity of the scroll bar images. description: | Determines the opacity of the scroll bar images (`Class.ScrollingFrame.TopImage|TopImage`, `Class.ScrollingFrame.MidImage|MidImage`, `Class.ScrollingFrame.BottomImage|BottomImage`). A value of `0` is completely opaque and a value of `1` is completely transparent (invisible). code_samples: [] type: float tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.ScrollBarThickness summary: | Thickness of the scroll bar in pixels; applies to both horizontal and vertical scroll bars. description: | Thickness of the scroll bar in pixels; applies to both horizontal and vertical scroll bars. If set to `0`, no scroll bars are rendered. code_samples: [] type: int tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.ScrollingDirection summary: | Determines the direction(s) in which scrolling is allowed. description: | 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 `Enum.ScrollingDirection.XY`. code_samples: [] type: ScrollingDirection tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.ScrollingEnabled summary: | Determines whether scrolling is allowed on the frame. description: | Determines whether scrolling is allowed on the frame. If `false`, no scroll bars will be rendered. code_samples: [] type: boolean tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.TopImage summary: | 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). description: | 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). Diagram showing the three image asset elements which construct a scrolling frame's scroll bar. code_samples: [] type: ContentId tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.TopImageContent summary: '' description: '' code_samples: [] type: Content tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.VerticalScrollBarInset summary: | Indicates whether `Class.ScrollingFrame.CanvasSize|CanvasSize` is inset by `Class.ScrollingFrame.ScrollBarThickness|ScrollBarThickness` on the vertical axis. description: | Indicates whether `Class.ScrollingFrame.CanvasSize|CanvasSize` is inset by `Class.ScrollingFrame.ScrollBarThickness|ScrollBarThickness` on the vertical axis. code_samples: [] type: ScrollBarInset tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI - name: ScrollingFrame.VerticalScrollBarPosition summary: | Indicates whether the vertical scroll bar is positioned to the left or right of the canvas. description: | Indicates whether the vertical scroll bar is positioned to the left or right of the canvas. Defaults to `Enum.VerticalScrollBarPosition.Right`. code_samples: [] type: VerticalScrollBarPosition tags: [] deprecation_message: '' security: read: None write: None thread_safety: ReadSafe category: Scrolling serialization: can_load: true can_save: true capabilities: - UI methods: [] events: [] callbacks: []