ToggleInput
Toggle switch 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 ToggleInput, run
# Create a page with the widget
example_page = [
ToggleInput(label="Toggle Input", key="my-toggle_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 toggle. | str | None |
key | Identifier for the widget, defaults to label if not provided. | str | None |
on_text | Text to display when the toggle is on. | str | 'Yes' |
off_text | Text to display when the toggle is off. | str | 'No' |
required | Whether the toggle must be switched on before proceeding. | bool | True |
hint | Help text displayed below the toggle. | str | None |
full_width | Whether the widget should take up the full width of its container. | bool | False |
disabled | Whether the toggle is non-interactive. | bool | False |
errors | Pre-defined validation error messages to display. | Union[List[str], str] | None |