| Function signature | |
|---|---|
st.radio(label, options, index=0, 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 radio group is for. |
options (Sequence, numpy.ndarray, pandas.Series, pandas.DataFrame, or pandas.Index) | Labels for the radio options. This will be cast to str internally by default. For pandas.DataFrame, the first column is selected. |
index (int) | The index of the preselected option on first render. |
format_func (function) | Function to modify the display of radio 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 radio. |
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 radio. |
on_change (callable) | An optional callback invoked when this radio'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 radio button if set to True. The default is False. This argument can only be supplied by keyword. |
| Returns | |
(any) | The selected option. |
Example
genre = st.radio(
"What's your favorite movie genre",
('Comedy', 'Drama', 'Documentary'))
if genre == 'Comedy':
st.write('You selected comedy.')
else:
st.write("You didn't select comedy.")
(view standalone Streamlit app)
Featured videos
Check out our video on how to use one of Streamlit's core functions, the radio button! 🔘
In the video below, we'll take it a step further and learn how to combine a button, checkbox and radio button!