| Function signature | |
|---|---|
st.multiselect(label, options, default=None, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False) | |
| Parameters | |
label (str) | A short label explaining to the user what this select widget is for. |
options (Sequence[V], 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 ([V], V, or None) | List of default values. Can also be a single value. |
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 multiselect. |
key (str or int) | An optional string or integer 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. |
disabled (bool) | An optional boolean, which disables the multiselect widget if set to True. The default is False. This argument can only be supplied by keyword. |
| Returns | |
(list) | A list with the selected options |
Example
options = st.multiselect( 'What are your favorite colors', ['Green', 'Yellow', 'Red', 'Blue'], ['Yellow', 'Red']) st.write('You selected:', options)(view standalone Streamlit app)Note
User experience can be degraded for large lists of options (100+), as this widget is not designed to handle arbitrary text search efficiently. See this thread on the Streamlit community forum for more information and GitHub issue #1059 for updates on the issue.