| Function signature | |
|---|---|
st.button(label, key=None, help=None, on_click=None, args=None, kwargs=None, *, disabled=False) | |
| Parameters | |
label (str) | A short label explaining to the user what this button is for. |
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 when the button is hovered over. |
on_click (callable) | An optional callback invoked when this button is clicked. |
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 button if set to True. The default is False. This argument can only be supplied by keyword. |
| Returns | |
(bool) | True if the button was clicked on the last run of the app, False otherwise. |
Example
if st.button('Say hello'):
st.write('Why hello there')
else:
st.write('Goodbye')
(view standalone Streamlit app)
Featured videos
Check out our video on how to use one of Streamlit's core functions, the button!
In the video below, we'll take it a step further and learn how to combine a button, checkbox and radio button!