Skip to content

Checkbox

A simple checkbox that can be either checked or unchecked.

Properties

Color, AppearanceOverride

Use the Color and AppearanceOverride properties to style the component.

Available colors are amber, blue, cyan, emerald, fuchsia, green, indigo, lime, neutral, orange, pink, purple, red, rose, sky, slate, stone, teal, violet, yellow, zinc. Available variants differ per color and can be viewed in the UI demo below.

The theme data for the component can be found in the Theming section and can be overwritten through AppearanceOverride.

Pass Color as a string and AppearanceOverride as an optionalColorTable. More information on overrides can be found here.

(image on the right in the demo has Disabled set to true)

Disabled

Type

luau

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

State

One-way Value

The state of the checkbox. This defaults to false.

Type

luau

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

Icon

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.

OnClick

Type

luau

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

Instance Properties

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

Theming

States

StateDescription
Base
Hover
Active
HoverActive
Disabled
DisabledActive

Colors

ColorDescription
Background
Text
Stroke