Interface ButtonProps

interface ButtonProps {
    Active: undefined | boolean | Binding<boolean>;
    AnchorPoint: undefined | Vector2 | Binding<Vector2>;
    Archivable: undefined | boolean | Binding<boolean>;
    AutoButtonColor: 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 | Binding<Color3> & 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>;
    Font:
        | undefined
        | Font
        | "Unknown"
        | "Legacy"
        | "Arial"
        | "ArialBold"
        | "SourceSans"
        | "SourceSansBold"
        | "SourceSansLight"
        | "SourceSansItalic"
        | "Bodoni"
        | "Garamond"
        | "Cartoon"
        | "Code"
        | "Highway"
        | "SciFi"
        | "Arcade"
        | "Fantasy"
        | "Antique"
        | "SourceSansSemibold"
        | "Gotham"
        | "GothamMedium"
        | "GothamBold"
        | "GothamBlack"
        | "AmaticSC"
        | "Bangers"
        | "Creepster"
        | "DenkOne"
        | "Fondamento"
        | "FredokaOne"
        | "GrenzeGotisch"
        | "IndieFlower"
        | "JosefinSans"
        | "Jura"
        | "Kalam"
        | "LuckiestGuy"
        | "Merriweather"
        | "Michroma"
        | "Nunito"
        | "Oswald"
        | "PatrickHand"
        | "PermanentMarker"
        | "Roboto"
        | "RobotoCondensed"
        | "RobotoMono"
        | "Sarpanch"
        | "SpecialElite"
        | "TitilliumWeb"
        | "Ubuntu"
        | "BuilderSans"
        | "BuilderSansMedium"
        | "BuilderSansBold"
        | "BuilderSansExtraBold"
        | "Arimo"
        | "ArimoBold"
        | Binding<Font>;
    FontFace: undefined | Font | Binding<Font>;
    FontSize:
        | undefined
        | FontSize
        | "Size8"
        | "Size9"
        | "Size10"
        | "Size11"
        | "Size12"
        | "Size14"
        | "Size18"
        | "Size24"
        | "Size36"
        | "Size48"
        | "Size28"
        | "Size32"
        | "Size42"
        | "Size60"
        | "Size96"
        | Binding<FontSize>;
    Gap?: number;
    HorizontalAlignment?: HorizontalAlignment;
    Interactable: undefined | boolean | Binding<boolean>;
    LayoutOrder: undefined | number | Binding<number>;
    LineHeight: undefined | number | Binding<number>;
    ListLayoutProps?: InstanceProps<UIListLayout>;
    Localize: undefined | boolean | Binding<boolean>;
    MaxVisibleGraphemes: undefined | number | Binding<number>;
    Modal: 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>;
    OpenTypeFeatures: undefined | string | Binding<string>;
    Padding?: number;
    PaddingProps?: InstanceProps<UIPadding>;
    PaddingX?: number;
    PaddingY?: number;
    Position: undefined | UDim2 | Binding<UDim2>;
    Ref?: Ref<unknown>;
    RichText: undefined | boolean | Binding<boolean>;
    RootLocalizationTable: LocalizationTable | Ref<LocalizationTable> | Binding<undefined | LocalizationTable>;
    Rotation: undefined | number | Binding<number>;
    Selectable: undefined | boolean | Binding<boolean>;
    Selected: 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>;
    Style:
        | undefined
        | ButtonStyle
        | "Custom"
        | "RobloxButtonDefault"
        | "RobloxButton"
        | "RobloxRoundButton"
        | "RobloxRoundDefaultButton"
        | "RobloxRoundDropdownButton"
        | Binding<ButtonStyle>;
    Text: undefined | string | Binding<string>;
    TextColor: undefined | BrickColor<keyof BrickColorsByNumber> | Binding<BrickColor<keyof BrickColorsByNumber>>;
    TextColor3: undefined | Color3 | Binding<Color3>;
    TextDirection:
        | undefined
        | TextDirection
        | "Auto"
        | "LeftToRight"
        | "RightToLeft"
        | Binding<TextDirection>;
    TextScaled: undefined | boolean | Binding<boolean>;
    TextSize: undefined | number | Binding<number>;
    TextStrokeColor3: undefined | Color3 | Binding<Color3>;
    TextStrokeTransparency: undefined | number | Binding<number>;
    TextTransparency: undefined | number | Binding<number>;
    TextTruncate:
        | undefined
        | TextTruncate
        | "None"
        | "AtEnd"
        | "SplitWord"
        | Binding<TextTruncate>;
    TextWrap: undefined | boolean | Binding<boolean>;
    TextWrapped: undefined | boolean | Binding<boolean>;
    TextXAlignment:
        | undefined
        | TextXAlignment
        | "Left"
        | "Right"
        | "Center"
        | Binding<TextXAlignment>;
    TextYAlignment:
        | undefined
        | TextYAlignment
        | "Top"
        | "Bottom"
        | "Center"
        | Binding<TextYAlignment>;
    Transparency: undefined | number | Binding<number>;
    VerticalAlignment?: VerticalAlignment;
    Visible: undefined | boolean | Binding<boolean>;
    ZIndex: undefined | number | Binding<number>;
}

Hierarchy (view full)

Properties

Active AnchorPoint Archivable AutoButtonColor AutoLocalize AutomaticSize BackgroundColor BackgroundColor3 BackgroundTransparency BorderColor BorderColor3? BorderMode BorderRadius? BorderSizePixel BorderThickness? Center? ClipsDescendants Component? CornerProps? Direction? DisableListLayout? Draggable Font FontFace FontSize Gap? HorizontalAlignment? Interactable LayoutOrder LineHeight ListLayoutProps? Localize MaxVisibleGraphemes Modal NextSelectionDown NextSelectionLeft NextSelectionRight NextSelectionUp OpenTypeFeatures Padding? PaddingProps? PaddingX? PaddingY? Position Ref? RichText RootLocalizationTable Rotation Selectable Selected SelectionBehaviorDown SelectionBehaviorLeft SelectionBehaviorRight SelectionBehaviorUp SelectionGroup SelectionImageObject SelectionOrder Size SizeConstraint StrokeProps? Style Text TextColor TextColor3 TextDirection TextScaled TextSize TextStrokeColor3 TextStrokeTransparency TextTransparency TextTruncate TextWrap TextWrapped TextXAlignment TextYAlignment Transparency VerticalAlignment? Visible ZIndex

Properties

Active

Active: undefined | boolean | Binding<boolean>

AnchorPoint

AnchorPoint: undefined | Vector2 | Binding<Vector2>

Archivable

Archivable: undefined | boolean | Binding<boolean>

AutoButtonColor

AutoButtonColor: 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 | Binding<Color3> & 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>

Font

Font:
    | undefined
    | Font
    | "Unknown"
    | "Legacy"
    | "Arial"
    | "ArialBold"
    | "SourceSans"
    | "SourceSansBold"
    | "SourceSansLight"
    | "SourceSansItalic"
    | "Bodoni"
    | "Garamond"
    | "Cartoon"
    | "Code"
    | "Highway"
    | "SciFi"
    | "Arcade"
    | "Fantasy"
    | "Antique"
    | "SourceSansSemibold"
    | "Gotham"
    | "GothamMedium"
    | "GothamBold"
    | "GothamBlack"
    | "AmaticSC"
    | "Bangers"
    | "Creepster"
    | "DenkOne"
    | "Fondamento"
    | "FredokaOne"
    | "GrenzeGotisch"
    | "IndieFlower"
    | "JosefinSans"
    | "Jura"
    | "Kalam"
    | "LuckiestGuy"
    | "Merriweather"
    | "Michroma"
    | "Nunito"
    | "Oswald"
    | "PatrickHand"
    | "PermanentMarker"
    | "Roboto"
    | "RobotoCondensed"
    | "RobotoMono"
    | "Sarpanch"
    | "SpecialElite"
    | "TitilliumWeb"
    | "Ubuntu"
    | "BuilderSans"
    | "BuilderSansMedium"
    | "BuilderSansBold"
    | "BuilderSansExtraBold"
    | "Arimo"
    | "ArimoBold"
    | Binding<Font>

FontFace

FontFace: undefined | Font | Binding<Font>

FontSize

FontSize:
    | undefined
    | FontSize
    | "Size8"
    | "Size9"
    | "Size10"
    | "Size11"
    | "Size12"
    | "Size14"
    | "Size18"
    | "Size24"
    | "Size36"
    | "Size48"
    | "Size28"
    | "Size32"
    | "Size42"
    | "Size60"
    | "Size96"
    | Binding<FontSize>

OptionalGap

Gap?: number

OptionalHorizontalAlignment

HorizontalAlignment?: HorizontalAlignment

Interactable

Interactable: undefined | boolean | Binding<boolean>

LayoutOrder

LayoutOrder: undefined | number | Binding<number>

LineHeight

LineHeight: undefined | number | Binding<number>

OptionalListLayoutProps

ListLayoutProps?: InstanceProps<UIListLayout>

Localize

Localize: undefined | boolean | Binding<boolean>

MaxVisibleGraphemes

MaxVisibleGraphemes: undefined | number | Binding<number>

Modal

Modal: 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>

OpenTypeFeatures

OpenTypeFeatures: undefined | string | Binding<string>

OptionalPadding

Padding?: number

OptionalPaddingProps

PaddingProps?: InstanceProps<UIPadding>

OptionalPaddingX

PaddingX?: number

OptionalPaddingY

PaddingY?: number

Position

Position: undefined | UDim2 | Binding<UDim2>

OptionalRef

Ref?: Ref<unknown>

RichText

RichText: undefined | boolean | Binding<boolean>

RootLocalizationTable

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

Rotation

Rotation: undefined | number | Binding<number>

Selectable

Selectable: undefined | boolean | Binding<boolean>

Selected

Selected: 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>

Style

Style:
    | undefined
    | ButtonStyle
    | "Custom"
    | "RobloxButtonDefault"
    | "RobloxButton"
    | "RobloxRoundButton"
    | "RobloxRoundDefaultButton"
    | "RobloxRoundDropdownButton"
    | Binding<ButtonStyle>

Text

Text: undefined | string | Binding<string>

TextColor

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

TextColor3

TextColor3: undefined | Color3 | Binding<Color3>

TextDirection

TextDirection:
    | undefined
    | TextDirection
    | "Auto"
    | "LeftToRight"
    | "RightToLeft"
    | Binding<TextDirection>

TextScaled

TextScaled: undefined | boolean | Binding<boolean>

TextSize

TextSize: undefined | number | Binding<number>

TextStrokeColor3

TextStrokeColor3: undefined | Color3 | Binding<Color3>

TextStrokeTransparency

TextStrokeTransparency: undefined | number | Binding<number>

TextTransparency

TextTransparency: undefined | number | Binding<number>

TextTruncate

TextTruncate:
    | undefined
    | TextTruncate
    | "None"
    | "AtEnd"
    | "SplitWord"
    | Binding<TextTruncate>

TextWrap

TextWrap: undefined | boolean | Binding<boolean>

TextWrapped

TextWrapped: undefined | boolean | Binding<boolean>

TextXAlignment

TextXAlignment:
    | undefined
    | TextXAlignment
    | "Left"
    | "Right"
    | "Center"
    | Binding<TextXAlignment>

TextYAlignment

TextYAlignment:
    | undefined
    | TextYAlignment
    | "Top"
    | "Bottom"
    | "Center"
    | Binding<TextYAlignment>

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
ActiveAnchorPointArchivableAutoButtonColorAutoLocalizeAutomaticSizeBackgroundColorBackgroundColor3BackgroundTransparencyBorderColorBorderColor3BorderModeBorderRadiusBorderSizePixelBorderThicknessCenterClipsDescendantsComponentCornerPropsDirectionDisableListLayoutDraggableFontFontFaceFontSizeGapHorizontalAlignmentInteractableLayoutOrderLineHeightListLayoutPropsLocalizeMaxVisibleGraphemesModalNextSelectionDownNextSelectionLeftNextSelectionRightNextSelectionUpOpenTypeFeaturesPaddingPaddingPropsPaddingXPaddingYPositionRefRichTextRootLocalizationTableRotationSelectableSelectedSelectionBehaviorDownSelectionBehaviorLeftSelectionBehaviorRightSelectionBehaviorUpSelectionGroupSelectionImageObjectSelectionOrderSizeSizeConstraintStrokePropsStyleTextTextColorTextColor3TextDirectionTextScaledTextSizeTextStrokeColor3TextStrokeTransparencyTextTransparencyTextTruncateTextWrapTextWrappedTextXAlignmentTextYAlignmentTransparencyVerticalAlignmentVisibleZIndex