Checkbox#

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

import panel as pn
import panel_material_ui as pmui

pn.extension()

The Checkbox widget allows toggling a single condition between True/False states by ticking a checkbox. 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 checkbox is checked or not
    • 







Display#


    

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







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
    • 





checkbox = pmui.Checkbox(name='Checkbox')

checkbox







            
            
Checkbox.value parameter is either True or False depending on whether the checkbox is ticked.


checkbox.value





False








Controls#


The Checkbox 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(checkbox.controls(jslink=True), checkbox)







            
            


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