| Function signature[source] | |
|---|---|
st.checkbox(label, value=False, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility="visible") | |
| Parameters | |
label (str) | A short label explaining to the user what this checkbox 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. 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, but you can hide it with label_visibility if needed. In the future, we may disallow empty labels by raising an exception. |
value (bool) | Preselect the checkbox when it first renders. This will be cast to bool internally. |
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. No two widgets may have the same key. |
help (str) | An optional tooltip that gets displayed next to the widget label. Streamlit only displays the tooltip when label_visibility="visible". |
on_change (callable) | An optional callback invoked when this checkbox'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 that disables the checkbox 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 alligned with other widgets. If this is "collapsed", Streamlit displays no label or spacer. |
| Returns | |
(bool) | Whether or not the checkbox is checked. |
Example
import streamlit as st agree = st.checkbox("I agree") if agree: st.write("Great!")
Featured videos
Check out our video on how to use one of Streamlit's core functions, the checkbox! ☑
In the video below, we'll take it a step further and learn how to combine a button, checkbox and radio button!
Still have questions?
Our forums are full of helpful information and Streamlit experts.