Skip to main content

Checkbox

Useful for settings, to-do lists, and anything needing a "Check!"

Types​

CheckboxProps​

</>
interface CheckboxProps {
...: BaseButtonProps--

All BaseButton properties are accepted.

Checked: boolean?--

Whether the checkbox is checked.

Icon: string?--

The icon to display inside the checkbox.

Color: Color3?--

The color of the checkbox.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "CheckboxProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "BaseButtonProps",
                    "desc": "All BaseButton properties are accepted."
                },
                {
                    "name": "Checked",
                    "lua_type": "boolean?",
                    "desc": "Whether the checkbox is checked."
                },
                {
                    "name": "Icon",
                    "lua_type": "string?",
                    "desc": "The icon to display inside the checkbox."
                },
                {
                    "name": "Color",
                    "lua_type": "Color3?",
                    "desc": "The color of the checkbox."
                }
            ],
            "source": {
                "line": 16,
                "path": "src/Components/Checkbox.luau"
            }
        }
    ],
    "name": "Checkbox",
    "desc": "Useful for settings, to-do lists, and anything needing a \"Check!\"",
    "source": {
        "line": 6,
        "path": "src/Components/Checkbox.luau"
    }
}