Switch#

Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).

Material version available

pn.ui.Switch resolves to the Material Design implementation of this component, documented in the panel-material-ui reference. This page documents the classic pn.widgets.Switch.

import panel as pn
pn.extension()

The Switch widget allows toggling a single condition between True/False states by ticking a switch. The Checkbox, Toggle, and Switch widgets are interchangeable.


Discover more on using widgets to add interactivity to your applications in the how-to guides on interactivity. Alternatively, learn how to set up callbacks and (JS-)links between parameters or how to use them as part of declarative UIs with Param.




Parameters:#


For details on other options for customizing the component see the layout and styling how-to guides.




Core#


    

  • value (boolean): Whether the switch is on or off
    • 







Display#


    

  • disabled (boolean): Whether the widget is editable
    • 

  • label (str): The title of the widget
    • 

  • name (str): Deprecated alias for label; use label instead.
    • 





switch = pn.widgets.Switch(label='Switch')

switch







            
            
Switch.value parameter is either True or False depending on whether the switch is ticked.


switch.value





False








Controls#


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


pn.Row(switch.controls(jslink=True), switch)







            
            


Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).