CheckboxInput
Checkbox input widget for capturing boolean values.
Examples
Basic Usage
This example runs a form with a single page containing the widget
Example Code
from abstra.forms import CheckboxInput, run
# Create a page with the widget
example_page = [
CheckboxInput(label="Checkbox Input", key="my-checkbox_input"),
]
# Run the form
result = run([example_page])
# Print the result
print(result)
Parameters
Name | Description | Type | Default |
---|---|---|---|
label (required) | Text label displayed next to the checkbox. | str | None |
key | Identifier for the widget, defaults to label if not provided. | str | None |
required | Whether the checkbox must be checked before proceeding. | bool | True |
hint | Help text displayed below the checkbox. | str | None |
full_width | Whether the widget should take up the full width of its container. | bool | False |
disabled | Whether the checkbox is non-interactive. | bool | False |
errors | Pre-defined validation error messages to display. | Union[list, str] | None |