Skip to content

BaseScrollFrameProperties

export type BaseScrollFrameProperties = {
    ScrollBarBorderMode: CanBeState<Enum.BorderMode>?,
    CanvasSize: CanBeState<UDim2>?,
    ScrollingEnabled: CanBeState<boolean>?,
    ScrollBarThickness: CanBeState<number>?,
    VerticalScrollBarPosition: CanBeState<Enum.VerticalScrollBarPosition>?,
    VerticalScrollBarInset: CanBeState<Enum.ScrollBarInset>?,
    CornerRadius: CanBeState<UDim>?,
    [any]: any,
}

The BaseScrollFrameProperties table that is given to the BaseScrollFrame() function that contains data about the desired BaseScrollFrame.


Properties

ScrollBarBorderMode : CanBeState<Enum.BorderMode>?

Sets the border mode of the BaseScrollFrame. Can either be a State containing the Enum, or the Enum.


CanvasSize : CanBeState<UDim2>?

Sets the canvas size of the BaseScrollFrame. Can either be a State containing an UDim2, or an UDim2.


ScrollingEnabled : CanBeState<boolean>?

Sets the whether or not the user can scroll within the BaseScrollFrame. Can either be a State containing a boolean, or a boolean.


ScrollBarThickness : CanBeState<number>?

Sets the thickness of the ScrollBar within the BaseScrollFrame. Can either be a State containing a number, or a number.


VerticalScrollBarPosition : CanBeState<Enum.VerticalScrollBarPosition>?

Sets the position of the ScrollBar within the BaseScrollFrame. Can either be a State containing the Enum, or the Enum.


VerticalScrollBarInset : CanBeState<Enum.ScrollBarInset>?

Sets whether the canvas should be inset by the ScrollBarThickness for the respective ScrollBar within the BaseScrollFrame. Can either be a State containing the Enum, or the Enum.


CornerRadius : CanBeState<UDim>?

Sets the canvas size of the BaseScrollFrame. Can either be a State containing an UDim2, or an UDim2.