A helper node for displaying scrollable elements such as lists.
A ScrollContainer node meant to contain a [Control] child.
ScrollContainers will automatically create a scrollbar child ([HScrollBar], [VScrollBar], or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the [member Control.custom_minimum_size] of the Control relative to the ScrollContainer.
Works great with a [Panel] control. You can set [constant Control.SIZE_EXPAND] on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension).
$DOCS_URL/tutorials/ui/gui_containers.html
Ensures the given [param control] is visible (must be a direct or indirect child of the ScrollContainer). Used by [member follow_focus].
[b]Note:[/b] This will not work on a node that was just added during the same frame. If you want to scroll to a newly added child, you must wait until the next frame using [signal SceneTree.process_frame]:
[codeblock]
add_child(child_node)
await get_tree().process_frame
ensure_control_visible(child_node)
[/codeblock]
Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer].
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable or hide a scrollbar, you can use [member horizontal_scroll_mode].
Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer].
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable or hide a scrollbar, you can use [member vertical_scroll_mode].
If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
Controls whether horizontal scrollbar can be used and when it should be visible. See [enum ScrollMode] for options.
Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive.
The current horizontal scroll value.
The current vertical scroll value.
Controls whether vertical scrollbar can be used and when it should be visible. See [enum ScrollMode] for options.
Emitted when scrolling stops.
Emitted when scrolling is started.
Scrolling disabled, scrollbar will be invisible.
Scrolling enabled, scrollbar will be visible only if necessary, i.e. container's content is bigger than the container.
Scrolling enabled, scrollbar will be always visible.
Scrolling enabled, scrollbar will be hidden.
The background [StyleBox] of the [ScrollContainer].