MultiSelect#

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

import panel as pn
pn.extension()

The MultiSelect widget allows selecting multiple values from a list of options. It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the CrossSelector, CheckBoxGroup 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 option values

Display#

disabled (boolean): Whether the widget is editable
name (str): The title of the widget

Events#

on_double_click (Callable[DoubleClickEvent, None]): Allows registering a callback that fires when an option is double clicked. The callback is given a DoubleClickEvent containing the clicked option.

multi_select = pn.widgets.MultiSelect(name='MultiSelect', value=['Apple', 'Pear'],
    options=['Apple', 'Banana', 'Pear', 'Strawberry'], size=8)

multi_select

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

multi_select.value

['Apple', 'Pear']

Controls#

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

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