Display a multiselect widget.

The multiselect widget starts as empty.

Function signature

st.multiselect(label, options, default=None, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None)

Parameters

label (str)

A short label explaining to the user what this select widget is for.

options (Sequence, numpy.ndarray, pandas.Series, pandas.DataFrame, or pandas.Index)

Labels for the select options. This will be cast to str internally by default. For pandas.DataFrame, the first column is selected.

default ([str] or None)

List of default values.

format_func (function)

Function to modify the display of selectbox options. It receives the raw option as an argument and should output the label to be shown for that option. This has no impact on the return value of the selectbox.

key (str)

An optional string to use as the unique key for the widget. If this is omitted, a key will be generated for the widget based on its content. Multiple widgets of the same type may not share the same key.

help (str)

An optional tooltip that gets displayed next to the multiselect.

on_change (callable)

An optional callback invoked when this multiselect's value changes.

args (tuple)

An optional tuple of args to pass to the callback.

kwargs (dict)

An optional dict of kwargs to pass to the callback.

Was this page helpful?

editSuggest edits
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.