Checkbox#

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


import panel as pn
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.

For more information about listening to widget events and laying out widgets refer to the widgets user guide. Alternatively you can learn how to build GUIs by declaring parameters independently of any specific widgets in the param user guide. To express interactivity entirely using Javascript without the need for a Python server take a look at the links user guide.

Parameters:#

For layout and styling related parameters see the customization user guide.

Core#

  • value (boolean): Whether the checkbox is checked or not

Display#

  • disabled (boolean): Whether the widget is editable

  • name (str): The title of the widget


checkbox = pn.widgets.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)
This web page was generated from a Jupyter notebook and not all interactivity will work on this website. Right click to download and run locally for full Python-backed interactivity.

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