Skip to content

IconButtonProperties 

export type IconButtonProperties = BaseButtonProperties & {
    ImageColorStyle: CanBeState<Enum.StudioStyleGuideColor>?,
    ImageColorModifier: CanBeState<Enum.StudioStyleGuideModifier>?,
    Icon: CanBeState<string>,
    IconColor3: CanBeState<Color3>?,
    CornerRadius: CanBeState<UDim>?,
    Timeout: CanBeValue<number>?,
    TextSize: nil,
    TextColorStyle: nil,
    [any]: any,
}

The IconButtonProperties table that is given to the IconButton() function that contains data about the desired IconButton.

This type is also an extension of the BaseButtonProperties type.

Properties

ImageColorStyle : CanBeState<Enum.StudioStyleGuideColor>?

Sets the color style of the image to the given Enum or a State containing that Enum.

ImageColorModifier : CanBeState<Enum.StudioStyleGuideModifier>?

Sets the color style modifier of the image to the given Enum or a State containing that Enum.

Icon : CanBeState<string>?

The image that will appear on the IconButton. Can either be a State containing a string, or a string.

IconColor3 : CanBeState<Color3>?

The color of the icon on the IconButton. Can either be a State containing a Color3, or a Color3. Setting this property is not recommended, as it will overwrite the default color defined by the theme of the Studio.

CornerRadius : CanBeState<UDim>?

Sets the corner radius of the IconButton. Can either be a State containing an UDim, or an UDim.

Timeout : CanBeValue<number>?

This property determines if the IconButton will be disabled for a certain period of time after it's been activated. Can either be a Value containing a number, or a number.