Switch#

Download this notebook from GitHub (right-click to download).

import panel as pn
import panel_material_ui as pmui

pn.extension()

The Switch widget allows toggling a single condition between True/False states by ticking a switch. This widget is interchangeable with the Toggle widget.


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 customization guides.




Core#


    

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

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







Display#


    

  • color (str): A color variant; should be one of 'default' (white), 'primary' (blue), 'success' (green), 'info' (yellow), 'light' (light), or 'danger' (red).
    • 

  • description (str): Description to display on hover.
    • 

  • edge (Literal["start", "end", False]): Where to render the edge.
    • 

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

  • size (Literal["small", "medium", "large"]): The size of the Switch.
    • 







Styling#


    

  • sx (dict): Component level styling API.
    • 

  • theme_config (dict): Theming API.
    • 







Aliases#


For compatibility with Panel certain parameters are allowed as aliases:


    

  • name: Alias for label
    • 





switch = pmui.Switch(name='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)







            
            


Download this notebook from GitHub (right-click to download).