Skip to content

CheckboxProperties 

export type CheckboxProperties = {
    OnChange: ((newValue: boolean) -> nil)?,
    Alignment: CanBeState<Enum.HorizontalAlignment>?,
    Enabled: CanBeState<boolean>?,
    Text: CanBeState<string>?,
    Value: CanBeValue<boolean>?,
    [any]: any,
}

The CheckboxProperties table that is given to the Checkbox() function that contains data about the desired Checkbox.

Properties

OnChange : ((newValue: boolean) -> nil)?

The callback function that will be called when the Checkbox's value changes.

Alignment : CanBeState<Enum.HorizontalAlignment>?

Determines where the Checkbox will be aligned to. Can either be a State containing the Enum or the Enum.

Enabled : CanBeState<boolean>?

Sets whether the Checkbox will be enabled or not. Can either be a State containing a boolean, or a boolean.

Text : CanBeState<string>?

The text that will be visible alongside the Checkbox. Can either be a State containing a string, or a string.

Value : CanBeValue<boolean>?,

The initial value of the Checkbox. If not set, then the Checkbox will be indeterminate. Can either be a Value containing a boolean, or a boolean.