Toggle Switch¶
Last Updated: August 10, 2015
- class tethys_sdk.gizmos.ToggleSwitch(name, display_text='', on_label='ON', off_label='OFF', on_style='primary', off_style='default', size='regular', initial=False, disabled=False, error='', attributes={}, classes='')¶
Toggle switches can be used as an alternative to check boxes for boolean or binomial input. Toggle switches are implemented using the excellent Bootstrap Switch reference project.
- display_text¶
str
Display text for the label that accompanies switch
- name¶
str, required
Name of the input element that will be used for form submission
- on_label¶
str
Text that appears in the “on” position of the switch
- off_label¶
str
Text that appears in the “off” position of the switch
- on_style¶
str
Color of the “on” position. Either: ‘default’, ‘info’, ‘primary’, ‘success’, ‘warning’, or ‘danger’
- off_style¶
str
Color of the “off” position. Either: ‘default’, ‘info’, ‘primary’, ‘success’, ‘warning’, or ‘danger’
- size¶
str
Size of the switch. Either: ‘large’, ‘small’, or ‘mini’.
- initial¶
bool
The initial position of the switch (True for “on” and False for “off”)
- disabled¶
bool
Disabled state of the switch
- error¶
str
Error message for form validation
- attributes¶
dict
A dictionary representing additional HTML attributes to add to the primary element (e.g. {“onclick”: “run_me();”}).
- classes¶
str
Additional classes to add to the primary HTML element (e.g. “example-class another-class”).
Example
# CONTROLLER from tethys_sdk.gizmos import ToggleSwitch toggle_switch = ToggleSwitch(display_text='Defualt Toggle', name='toggle1') toggle_switch_styled = ToggleSwitch(display_text='Styled Toggle', name='toggle2', on_label='Yes', off_label='No', on_style='success', off_style='danger', initial=True, size='large') toggle_switch_disabled = ToggleSwitch(display_text='Disabled Toggle', name='toggle3', on_label='On', off_label='Off', on_style='success', off_style='warning', size='mini', initial=False, disabled=True, error='Here is my error text') # TEMPLATE {% gizmo toggle_switch toggle_switch %} {% gizmo toggle_switch toggle_switch_styled %} {% gizmo toggle_switch toggle_switch_disabled %}