ToggleInput
Toggle switch input widget for capturing boolean values.
Signature
def ToggleInput(
label: str,
key: str = None,
on_text: str = 'Yes',
off_text: str = 'No',
required: bool = True,
hint: str = None,
full_width: bool = False,
disabled: bool = False,
errors: Union[List[str], str] = None
)
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 |