Reflex Logo
Docs Logo
Library

/

Forms

/

Checkbox

The on_change trigger is called when the checkbox is clicked.

false

The input prop is used to set the checkbox as a controlled component.

Example Form

Results:

{}

API Reference

rx.checkbox

A checkbox component with a label.

PropType | ValuesDefaultInteractive
text
str
-
spacing
"0" | "1" | ...
-
size
"1" | "2" | ...
-
as_child
bool
-
variant
"classic" | "surface" | ...
-
color_scheme
"tomato" | "red" | ...
-
high_contrast
bool
-
default_checked
bool
-
checked
bool
-
disabled
bool
-
required
bool
-
name
str
-
value
str
-

Event Triggers

See the full list of default event triggers
TriggerDescription
on_changeFired when the checkbox is checked or unchecked.
Built with Reflex