Skip to main content

CheckboxInput

Checkbox input widget for capturing boolean values.

Signature

def CheckboxInput(
label: str,
key: str = None,
required: bool = True,
hint: str = None,
full_width: bool = False,
disabled: bool = False,
errors: Union[list, str] = None
)

Parameters

NameDescriptionTypeDefault
label (required)Text label displayed next to the checkbox.strNone
keyIdentifier for the widget, defaults to label if not provided.strNone
requiredWhether the checkbox must be checked before proceeding.boolTrue
hintHelp text displayed below the checkbox.strNone
full_widthWhether the widget should take up the full width of its container.boolFalse
disabledWhether the checkbox is non-interactive.boolFalse
errorsPre-defined validation error messages to display.Union[list, str]None