CheckBoxGroup#

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

import panel as pn

pn.extension()

The CheckBoxGroup widget allows selecting between a list of options by ticking the corresponding checkboxes. It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckButtonGroup widgets.

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#

options (list or dict): List or dictionary of options
value (list): Currently selected options

Display#

disabled (boolean): Whether the widget is editable
inline (boolean): Whether to arrange the items vertically in a column (False) or horizontally in a line (True)
name (str): The title of the widget

checkbox_group = pn.widgets.CheckBoxGroup(
    name='Checkbox Group', value=['Apple', 'Pear'], options=['Apple', 'Banana', 'Pear', 'Strawberry'],
    inline=True)

checkbox_group

CheckBoxGroup.value returns a list of the currently selected options:

checkbox_group.value

['Apple', 'Pear']

Controls#

The CheckboxBoxGroup 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_group.controls(jslink=True), checkbox_group)

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