An example of a default boolean switch without any extra properties.
Set the color of the boolean switch with
Set the label and label position using the
Create a vertical oriented switch by setting
To disable the Boolean Switch set the property
Access this documentation in your Python terminal with:
id (string; optional): The ID used to identify this compnent in Dash callbacks
color (string; optional): Color to highlight active switch background
className (string; optional): Class to apply to the root component element.
disabled (boolean; optional): If true, switch cannot be clicked
label (dict; optional): Description to be displayed alongside the control. To control styling, pass an object with label and style properties. label has the following type: string | dict containing keys ‘style’, ‘label’. Those keys have the following types:
labelPosition (a value equal to: ‘top’, ‘bottom’; default
'top'): Where the component label is positioned.
on (boolean; default
False): Whether or not the switch is on
persistence (boolean | string | number; optional): Used to allow user interactions in this component to be persisted when the component - or the page - is refreshed. If
persisted is truthy and hasn’t changed from its previous value, a
value that the user has changed while using the app will keep that change, as long as the new
value also matches what was given originally. Used in conjunction with
persisted_props (list of a value equal to: ‘on’s; default
['on']): Properties whose user interactions will persist after refreshing the component or the page. Since only
on is allowed this prop can normally be ignored.
persistence_type (a value equal to: ‘local’, ‘session’, ‘memory’; default
'local'): Where persisted user changes will be stored: memory: only kept in memory, reset on page refresh. local: window.localStorage, data is kept after the browser quit. session: window.sessionStorage, data is cleared once the browser quit.
style (dict; optional): Style to apply to the root object.
theme (dict; default
light): Theme configuration to be set by a ThemeProvider
vertical (boolean; default
False): If true, switch will be vertical instead of horizontal