| 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 Markdown and supports the following elements: Bold, Italics, Strikethroughs, Inline Code, Emojis, and Links. This also supports:
Unsupported 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. |
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. Multiple widgets of the same type may not share the same key. |
help (str) | An optional tooltip that gets displayed next to the checkbox. |
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, which disables the checkbox 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 (equivalent to label=""). If "collapsed", both the label and the space are removed. Default is "visible". This argument can only be supplied by keyword. |
| 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!