import panel as pn
pn.extension()
The CheckButtonGroup
widget allows selecting between a list of options by toggling the corresponding buttons. It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect
, CrossSelector
and CheckBoxGroup
widgets.
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.
For layout and styling related parameters see the customization user guide.
options
(list or dict): List or dictionary of optionsvalue
(boolean): Currently selected optionsbutton_type
(str): A button theme should be one of 'default'
(white), 'primary'
(blue), 'success'
(green), 'info'
(yellow), or 'danger'
(red)disabled
(boolean): Whether the widget is editablename
(str): The title of the widgetcheckbutton_group = pn.widgets.CheckButtonGroup(name='Check Button Group', value=['Apple', 'Pear'], options=['Apple', 'Banana', 'Pear', 'Strawberry'])
checkbutton_group
CheckButtonGroup.value
returns a list of the currently selected options:
checkbutton_group.value
The CheckButtonGroup
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(checkbutton_group.controls(jslink=True), checkbutton_group)