The Toggle widget allows toggling a single condition between True/False states. This widget is interchangeable with the Checkbox widget.

For more information about listening to widget events and laying out widgets refer to the widgets user guide. Alternatively you can learn how to build GUIs by declaring parameters independently of any specific widgets in the param user guide. To express interactivity entirely using Javascript without the need for a Python server take a look at the links user guide.

Parameters:¶

For layout and styling related parameters see the customization user guide.

Core¶

• value (boolean): Whether the button is toggled or not

Display¶

• button_type (str): A button theme should be one of 'default' (white), 'primary' (blue), 'success' (green), 'info' (yellow), or 'danger' (red)
• disabled (boolean): Whether the widget is editable
• name (str): The title of the widget

Toggle.value is either True or False depending on whether the button is toggled:

The color of the Toggle can be selected using one of the available button_types:

Controls¶

The Toggle widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively: