Interface BaseBoxProps

interface BaseBoxProps {
    Active: undefined | boolean | Binding<boolean>;
    AnchorPoint: undefined | Vector2 | Binding<Vector2>;
    Archivable: undefined | boolean | Binding<boolean>;
    AutoLocalize: undefined | boolean | Binding<boolean>;
    AutomaticSize:
        | undefined
        | AutomaticSize
        | "X"
        | "Y"
        | "None"
        | "XY"
        | Binding<AutomaticSize>;
    BackgroundColor: undefined | BrickColor<keyof BrickColorsByNumber> | Binding<BrickColor<keyof BrickColorsByNumber>>;
    BackgroundColor3: undefined | Color3 | Binding<Color3>;
    BackgroundTransparency: undefined | number | Binding<number>;
    BorderColor: undefined | BrickColor<keyof BrickColorsByNumber> | Binding<BrickColor<keyof BrickColorsByNumber>>;
    BorderColor3?: Color3;
    BorderMode:
        | undefined
        | BorderMode
        | "Outline"
        | "Middle"
        | "Inset"
        | Binding<BorderMode>;
    BorderRadius?: number;
    BorderSizePixel: undefined | number | Binding<number>;
    BorderThickness?: number;
    Center?: boolean;
    ClipsDescendants: undefined | boolean | Binding<boolean>;
    Component?: keyof IntrinsicElements;
    CornerProps?: InstanceProps<UICorner>;
    Direction?: FillDirection;
    DisableListLayout?: boolean;
    Draggable: undefined | boolean | Binding<boolean>;
    Gap?: number;
    HorizontalAlignment?: HorizontalAlignment;
    Interactable: undefined | boolean | Binding<boolean>;
    LayoutOrder: undefined | number | Binding<number>;
    ListLayoutProps?: InstanceProps<UIListLayout>;
    Localize: undefined | boolean | Binding<boolean>;
    NextSelectionDown: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>;
    NextSelectionLeft: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>;
    NextSelectionRight: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>;
    NextSelectionUp: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>;
    Padding?: number;
    PaddingProps?: InstanceProps<UIPadding>;
    PaddingX?: number;
    PaddingY?: number;
    Position: undefined | UDim2 | Binding<UDim2>;
    Ref?: Ref<unknown>;
    RootLocalizationTable: LocalizationTable | Ref<LocalizationTable> | Binding<undefined | LocalizationTable>;
    Rotation: undefined | number | Binding<number>;
    Selectable: undefined | boolean | Binding<boolean>;
    SelectionBehaviorDown:
        | undefined
        | SelectionBehavior
        | "Stop"
        | "Escape"
        | Binding<SelectionBehavior>;
    SelectionBehaviorLeft:
        | undefined
        | SelectionBehavior
        | "Stop"
        | "Escape"
        | Binding<SelectionBehavior>;
    SelectionBehaviorRight:
        | undefined
        | SelectionBehavior
        | "Stop"
        | "Escape"
        | Binding<SelectionBehavior>;
    SelectionBehaviorUp:
        | undefined
        | SelectionBehavior
        | "Stop"
        | "Escape"
        | Binding<SelectionBehavior>;
    SelectionGroup: undefined | boolean | Binding<boolean>;
    SelectionImageObject: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>;
    SelectionOrder: undefined | number | Binding<number>;
    Size: undefined | UDim2 | Binding<UDim2>;
    SizeConstraint:
        | undefined
        | SizeConstraint
        | "RelativeXY"
        | "RelativeXX"
        | "RelativeYY"
        | Binding<SizeConstraint>;
    StrokeProps?: InstanceProps<UIStroke>;
    Transparency: undefined | number | Binding<number>;
    VerticalAlignment?: VerticalAlignment;
    Visible: undefined | boolean | Binding<boolean>;
    ZIndex: undefined | number | Binding<number>;
}

Hierarchy

  • PropsWithoutRef<InstanceProps<GuiObject>>
    • BaseBoxProps

Properties

Active AnchorPoint Archivable AutoLocalize AutomaticSize BackgroundColor BackgroundColor3 BackgroundTransparency BorderColor BorderColor3? BorderMode BorderRadius? BorderSizePixel BorderThickness? Center? ClipsDescendants Component? CornerProps? Direction? DisableListLayout? Draggable Gap? HorizontalAlignment? Interactable LayoutOrder ListLayoutProps? Localize NextSelectionDown NextSelectionLeft NextSelectionRight NextSelectionUp Padding? PaddingProps? PaddingX? PaddingY? Position Ref? RootLocalizationTable Rotation Selectable SelectionBehaviorDown SelectionBehaviorLeft SelectionBehaviorRight SelectionBehaviorUp SelectionGroup SelectionImageObject SelectionOrder Size SizeConstraint StrokeProps? Transparency VerticalAlignment? Visible ZIndex

Properties

Active

Active: undefined | boolean | Binding<boolean>

AnchorPoint

AnchorPoint: undefined | Vector2 | Binding<Vector2>

Archivable

Archivable: undefined | boolean | Binding<boolean>

AutoLocalize

AutoLocalize: undefined | boolean | Binding<boolean>

AutomaticSize

AutomaticSize:
    | undefined
    | AutomaticSize
    | "X"
    | "Y"
    | "None"
    | "XY"
    | Binding<AutomaticSize>

BackgroundColor

BackgroundColor: undefined | BrickColor<keyof BrickColorsByNumber> | Binding<BrickColor<keyof BrickColorsByNumber>>

BackgroundColor3

BackgroundColor3: undefined | Color3 | Binding<Color3>

BackgroundTransparency

BackgroundTransparency: undefined | number | Binding<number>

BorderColor

BorderColor: undefined | BrickColor<keyof BrickColorsByNumber> | Binding<BrickColor<keyof BrickColorsByNumber>>

OptionalBorderColor3

BorderColor3?: Color3

BorderMode

BorderMode:
    | undefined
    | BorderMode
    | "Outline"
    | "Middle"
    | "Inset"
    | Binding<BorderMode>

OptionalBorderRadius

BorderRadius?: number

BorderSizePixel

BorderSizePixel: undefined | number | Binding<number>

OptionalBorderThickness

BorderThickness?: number

OptionalCenter

Center?: boolean

ClipsDescendants

ClipsDescendants: undefined | boolean | Binding<boolean>

OptionalComponent

Component?: keyof IntrinsicElements

OptionalCornerProps

CornerProps?: InstanceProps<UICorner>

OptionalDirection

Direction?: FillDirection

OptionalDisableListLayout

DisableListLayout?: boolean

Draggable

Draggable: undefined | boolean | Binding<boolean>

OptionalGap

Gap?: number

OptionalHorizontalAlignment

HorizontalAlignment?: HorizontalAlignment

Interactable

Interactable: undefined | boolean | Binding<boolean>

LayoutOrder

LayoutOrder: undefined | number | Binding<number>

OptionalListLayoutProps

ListLayoutProps?: InstanceProps<UIListLayout>

Localize

Localize: undefined | boolean | Binding<boolean>

NextSelectionDown

NextSelectionDown: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>

NextSelectionLeft

NextSelectionLeft: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>

NextSelectionRight

NextSelectionRight: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>

NextSelectionUp

NextSelectionUp: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>

OptionalPadding

Padding?: number

OptionalPaddingProps

PaddingProps?: InstanceProps<UIPadding>

OptionalPaddingX

PaddingX?: number

OptionalPaddingY

PaddingY?: number

Position

Position: undefined | UDim2 | Binding<UDim2>

OptionalRef

Ref?: Ref<unknown>

RootLocalizationTable

RootLocalizationTable: LocalizationTable | Ref<LocalizationTable> | Binding<undefined | LocalizationTable>

Rotation

Rotation: undefined | number | Binding<number>

Selectable

Selectable: undefined | boolean | Binding<boolean>

SelectionBehaviorDown

SelectionBehaviorDown:
    | undefined
    | SelectionBehavior
    | "Stop"
    | "Escape"
    | Binding<SelectionBehavior>

SelectionBehaviorLeft

SelectionBehaviorLeft:
    | undefined
    | SelectionBehavior
    | "Stop"
    | "Escape"
    | Binding<SelectionBehavior>

SelectionBehaviorRight

SelectionBehaviorRight:
    | undefined
    | SelectionBehavior
    | "Stop"
    | "Escape"
    | Binding<SelectionBehavior>

SelectionBehaviorUp

SelectionBehaviorUp:
    | undefined
    | SelectionBehavior
    | "Stop"
    | "Escape"
    | Binding<SelectionBehavior>

SelectionGroup

SelectionGroup: undefined | boolean | Binding<boolean>

SelectionImageObject

SelectionImageObject: GuiObject | Ref<GuiObject> | Binding<undefined | GuiObject>

SelectionOrder

SelectionOrder: undefined | number | Binding<number>

Size

Size: undefined | UDim2 | Binding<UDim2>

SizeConstraint

SizeConstraint:
    | undefined
    | SizeConstraint
    | "RelativeXY"
    | "RelativeXX"
    | "RelativeYY"
    | Binding<SizeConstraint>

OptionalStrokeProps

StrokeProps?: InstanceProps<UIStroke>

Transparency

Transparency: undefined | number | Binding<number>

OptionalVerticalAlignment

VerticalAlignment?: VerticalAlignment

Visible

Visible: undefined | boolean | Binding<boolean>

ZIndex

ZIndex: undefined | number | Binding<number>

Settings

Member Visibility

On This Page

Properties