Skip to main content

Scroller

For making Content scrollable. Equivalent to Roblox's Scroller instance.

Types​

ScrollerProps​

</>
interface ScrollerProps {
...: BaseProps--

All Base properties are accepted.

AutomaticCanvasSize: Enum.AutomaticSize?--

Determines whether the canvas size is automatically adjusted.

BottomImage: string?--

The image used for the bottom scroll bar.

CanvasPosition: Vector2?--

The position of the canvas.

CanvasSize: UDim2?--

The size of the canvas.

ElasticBehavior: Enum.ElasticBehavior?--

Determines the elastic behavior of the scrolling frame.

HorizontalScrollBarInset: Enum.ScrollBarInset?--

Determines the inset behavior of the horizontal scroll bar.

MidImage: string?--

The image used for the middle scroll bar.

ScrollBarImageColor3: Color3?--

The color of the scroll bar image.

ScrollBarImageTransparency: number?--

The transparency of the scroll bar image.

ScrollBarThickness: number?--

The thickness of the scroll bar.

ScrollingDirection: Enum.ScrollingDirection?--

The direction in which scrolling is allowed.

ScrollingEnabled: boolean?--

Determines whether scrolling is enabled.

TopImage: string?--

The image used for the top scroll bar.

VerticalScrollBarInset: Enum.ScrollBarInset?--

Determines the inset behavior of the vertical scroll bar.

VerticalScrollBarPosition: Enum.VerticalScrollBarPosition?--

Determines the position of the vertical scroll bar.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "ScrollerProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "BaseProps",
                    "desc": "All Base properties are accepted."
                },
                {
                    "name": "AutomaticCanvasSize",
                    "lua_type": "Enum.AutomaticSize?",
                    "desc": "Determines whether the canvas size is automatically adjusted."
                },
                {
                    "name": "BottomImage",
                    "lua_type": "string?",
                    "desc": "The image used for the bottom scroll bar."
                },
                {
                    "name": "CanvasPosition",
                    "lua_type": "Vector2?",
                    "desc": "The position of the canvas."
                },
                {
                    "name": "CanvasSize",
                    "lua_type": "UDim2?",
                    "desc": "The size of the canvas."
                },
                {
                    "name": "ElasticBehavior",
                    "lua_type": "Enum.ElasticBehavior?",
                    "desc": "Determines the elastic behavior of the scrolling frame."
                },
                {
                    "name": "HorizontalScrollBarInset",
                    "lua_type": "Enum.ScrollBarInset?",
                    "desc": "Determines the inset behavior of the horizontal scroll bar."
                },
                {
                    "name": "MidImage",
                    "lua_type": "string?",
                    "desc": "The image used for the middle scroll bar."
                },
                {
                    "name": "ScrollBarImageColor3",
                    "lua_type": "Color3?",
                    "desc": "The color of the scroll bar image."
                },
                {
                    "name": "ScrollBarImageTransparency",
                    "lua_type": "number?",
                    "desc": "The transparency of the scroll bar image."
                },
                {
                    "name": "ScrollBarThickness",
                    "lua_type": "number?",
                    "desc": "The thickness of the scroll bar."
                },
                {
                    "name": "ScrollingDirection",
                    "lua_type": "Enum.ScrollingDirection?",
                    "desc": "The direction in which scrolling is allowed."
                },
                {
                    "name": "ScrollingEnabled",
                    "lua_type": "boolean?",
                    "desc": "Determines whether scrolling is enabled."
                },
                {
                    "name": "TopImage",
                    "lua_type": "string?",
                    "desc": "The image used for the top scroll bar."
                },
                {
                    "name": "VerticalScrollBarInset",
                    "lua_type": "Enum.ScrollBarInset?",
                    "desc": "Determines the inset behavior of the vertical scroll bar."
                },
                {
                    "name": "VerticalScrollBarPosition",
                    "lua_type": "Enum.VerticalScrollBarPosition?",
                    "desc": "Determines the position of the vertical scroll bar."
                }
            ],
            "source": {
                "line": 28,
                "path": "src/Components/Scroller.luau"
            }
        }
    ],
    "name": "Scroller",
    "desc": "For making Content scrollable. Equivalent to Roblox's `Scroller` instance.",
    "source": {
        "line": 6,
        "path": "src/Components/Scroller.luau"
    }
}