st.segmented_control
Display a segmented control widget.
A segmented control widget is a linear set of segments where each of the passed options functions like a toggle button.
| Function signature[source] | |
|---|---|
st.segmented_control(label, options, *, selection_mode="single", default=None, required=False, format_func=None, key=None, help=None, on_change="rerun", args=None, kwargs=None, disabled=False, label_visibility="visible", width="content", wrap=None, bind=None, persist_state=None) | |
| Parameters | |
label (str) | A short label explaining to the user what this widget is for. The label can optionally contain GitHub-flavored Markdown of the following types: Bold, Italics, Strikethroughs, Inline Code, Links, and Images. Images display like icons, with a max height equal to the font height. Unsupported Markdown elements are unwrapped so only their children (text contents) render. Common block-level Markdown (headings, lists, blockquotes) is automatically escaped and displays as literal text in labels. See the body parameter of st.markdown for additional, supported Markdown directives. For accessibility reasons, you should never set an empty label, but you can hide it with label_visibility if needed. In the future, we may disallow empty labels by raising an exception. |
options (Iterable of V) | 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 and can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the body parameter of st.markdown. |
selection_mode ("single" or "multi") | The selection mode for the widget. If this is "single" (default), only one option can be selected. If this is "multi", multiple options can be selected. |
default (Iterable of V, V, or None) | The value of the widget when it first renders. If the selection_mode is multi, this can be a list of values, a single value, or None. If the selection_mode is "single", this can be a single value or None. |
required (bool) | Whether a selection is required. If this is True and selection_mode="single", users cannot deselect an option once one is selected. Clicking an already-selected option does nothing. The default is False. If required=True is used with selection_mode="multi", an exception is raised. |
format_func (function) | Function to modify the display of the 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 command. The output can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the body parameter of st.markdown. |
key (str, int, or None) | An optional string or integer to use as the unique key for the widget. If this is None (default), a key will be generated for the widget based on the values of the other parameters. No two widgets may have the same key. Assigning a key stabilizes the widget's identity and preserves its state across reruns even when other parameters change. Note Changing selection_mode resets the widget even when a key is provided. A key lets you read or update the widget's value via st.session_state[key]. For more details, see Widget behavior. Additionally, if key is provided, it will be used as a CSS class name prefixed with st-key-. |
help (str or None) | A tooltip that gets displayed next to the widget label. Streamlit only displays the tooltip when label_visibility="visible". If this is None (default), no tooltip is displayed. The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the body parameter of st.markdown. |
on_change (callable, "rerun", "ignore", or None) | How the segmented control should respond to value changes. This controls whether Streamlit reruns the app when the user interacts with the control. on_change can be one of the following:
|
args (list or tuple) | An optional list or 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 that disables the widget if set to True. The default is False. |
label_visibility ("visible", "hidden", or "collapsed") | The visibility of the label. The default is "visible". If this is "hidden", Streamlit displays an empty spacer instead of the label, which can help keep the widget aligned with other widgets. If this is "collapsed", Streamlit displays no label or spacer. |
width ("content", "stretch", or int) | The width of the segmented control widget. This can be one of the following:
|
wrap (bool or None) | Whether the options can wrap onto multiple rows. This can be one of the following:
|
bind ("query-params" or None) | Binding mode for syncing the widget's value with a URL query parameter. If this is None (default), the widget's value is not synced to the URL. When this is set to "query-params", changes to the widget update the URL, and the widget can be initialized or updated through a query parameter in the URL. This requires key to be set. The key is used as the query parameter name. When the widget's value equals its default, the query parameter is removed from the URL to keep it clean. A bound query parameter can't be set or deleted through st.query_params; it can only be programmatically changed through st.session_state. An empty query parameter (e.g., ?tags=) clears the widget. Invalid query parameter values are ignored and removed from the URL. For selection_mode="multi", multiple selections use repeated parameters (e.g., ?tags=Red&tags=Blue) and duplicates are deduplicated. When on_change="ignore", Streamlit updates the URL on the same commits described above. As with widgets inside a form, the URL can show a value that Python hasn't received yet. Python receives the new value on the next rerun, so a page load or share uses the updated URL value. |
persist_state ("page", "session", or None) | How long to preserve the widget's value when it isn't rendered. If this is None (default), the value is lost when the widget stops being rendered or the user switches pages. If this is "page", the value is preserved only while the user stays on the page where the widget is defined (for example, while the widget is conditionally hidden); it is discarded on a page switch and is not restored if the user returns to the page. If this is "session", the value is preserved for the entire session, including across page switches, so it returns when the user navigates back. This requires key to be set. If bind="query-params" is also set, the binding takes precedence: the value is stored in the URL, so it persists across page switches regardless of the persist_state scope. |
| Returns | |
(list of V, V, or None) | If the selection_mode is multi, this is a list of selected options or an empty list. If the selection_mode is "single", this is a selected option or None. This contains copies of the selected options, not the originals. |
Examples
Example 1: Multi-select segmented control
Display a multi-select segmented control widget, and show the selection:
import streamlit as st
options = ["North", "East", "South", "West"]
selection = st.segmented_control(
"Directions", options, selection_mode="multi"
)
st.markdown(f"Your selected options: {selection}.")
Example 2: Single-select segmented control with icons
Display a single-select segmented control widget with icons:
import streamlit as st
option_map = {
0: ":material/add:",
1: ":material/zoom_in:",
2: ":material/zoom_out:",
3: ":material/zoom_out_map:",
}
selection = st.segmented_control(
"Tool",
options=option_map.keys(),
format_func=lambda option: option_map[option],
selection_mode="single",
)
st.write(
"Your selected option: "
f"{None if selection is None else option_map[selection]}"
)
Tip
Want a new st.segmented_control feature or found a bug? Browse open issues and react with a 👍 on the initial post of the ones that matter to you. Your votes help us prioritize what to work on next.
Still have questions?
Our forums are full of helpful information and Streamlit experts.