Display a checkbox widget.
Function signature

st.checkbox(label, value=False, key=None, help=None)

Parameters

label (str)

A short label explaining to the user what this checkbox is for.

value (bool)

Preselect the checkbox when it first renders. This will be cast to bool internally.

key (str)

An optional string 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)

A tooltip that gets displayed next to the checkbox.

Was this page helpful?

editSuggest edits
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.