| Function signature[source] | |
|---|---|
st.multiselect(label, options, default=None, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None, *, max_selections=None, placeholder="Choose an option", disabled=False, label_visibility="visible") | |
| Parameters | |
label (str) | A short label explaining to the user what this select widget is for. The label can optionally contain GitHub-flavored Markdown of the following types: Bold, Italics, Strikethroughs, Inline Code, and Links. Unsupported Markdown elements are unwrapped so only their children (text contents) render. Display unsupported elements as literal characters by backslash-escaping them. E.g., "1\. Not an ordered list". See the body parameter of st.markdown for additional, supported Markdown directives. For accessibility reasons, you should never set an empty label (label="") but hide it with label_visibility if needed. In the future, we may disallow empty labels by raising an exception. |
options (Iterable) | Labels for the select options in an Iterable. This can be a list, set, or anything supported by st.dataframe. If options is dataframe-like, the first column will be used. Each label will be cast to str internally by default. |
default (Iterable of 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. |
max_selections (int) | The max selections that can be selected at a time. |
placeholder (str) | A string to display when no options are selected. Defaults to 'Choose an option'. |
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. |
label_visibility ("visible", "hidden", or "collapsed") | The visibility of the label. If "hidden", the label doesn't show but there is still empty space for it above the widget (equivalent to label=""). If "collapsed", both the label and the space are removed. Default is "visible". |
| Returns | |
(list) | A list with the selected options |
Example
import streamlit as st options = st.multiselect( "What are your favorite colors", ["Green", "Yellow", "Red", "Blue"], ["Yellow", "Red"], ) st.write("You selected:", options)
Still have questions?
Our forums are full of helpful information and Streamlit experts.