Skip to content

Button

A component that provides a strong base for interactive elements.

Properties

Appearance

Type

luau

Code block has not loaded. An error may have occurred.

Stroke

Type

luau

Code block has not loaded. An error may have occurred.

TweenSettings

The tween settings for transitioning between appearances.

Type

luau

Code block has not loaded. An error may have occurred.

CornerRadius

Type

luau

Code block has not loaded. An error may have occurred.

Padding

Type

luau

Code block has not loaded. An error may have occurred.

Content

Type

luau

Code block has not loaded. An error may have occurred.

OnClick

Type

luau

Code block has not loaded. An error may have occurred.

OnMouseButton2Click

Type

luau

Code block has not loaded. An error may have occurred.

OnMouseButton1Changed

This event is fired when the left mouse button is pressed or released.

Something to note is that when the mouse leaves the button, this event fires with false. This is done as a safety measure to ensure that the button is not stuck in a pressed state.

Type

luau

Code block has not loaded. An error may have occurred.

OnMouseButton2Changed

This event is fired when the right mouse button is pressed or released.

Something to note is that when the mouse leaves the button, this event fires with false. This is done as a safety measure to ensure that the button is not stuck in a pressed state.

Type

luau

Code block has not loaded. An error may have occurred.

OnHover

Type

luau

Code block has not loaded. An error may have occurred.

DisableHoverLighting

By default, the button will lighten on the mouse position when hovered. This property disables that effect.

Type

luau

Code block has not loaded. An error may have occurred.

Instance Properties

This instance takes all the properties of a TextButton. SpecialKeys, such as fusion.Children will also be passed to the instance.