Allow users to set between two items.

Basic Example

The following example demonstrate some of the available functionality for read_toggle

Toggle
Off

Custom Example

The following example demonstrate how to customize the toggle options text

Custom Toggle
Cancel

Function signature

See in Github
def (label: str, **kwargs):

Positional parameters

label (str)
The label to display to the user

Keyword Arguments

on_text (str)
Text of On Toggle option
off_text (str)
Text of Off Toggle option
disabled (bool)
whether the input is disabled. Defaults to False.
required (Union[bool, str])
Whether the input is required or not eg. "this field is required". Defaults to True.
hint (str)
A tooltip displayed to the user. Defaults to None.
end_program (bool)
Whether the program should end after the widget is shown. Defaults to False.
full_width (bool)
Whether the input should use full screen width. Defaults to False.
button_text (str)
What text to display on the button when the widget is not part of a Page. Defaults to 'Next'.

Returns

()bool: if the toggle was checked