函数签名[source] | |
---|---|
st.checkbox(label, value=False, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility="visible") | |
参数 | |
label (str) | 一个简短的标签,向用户解释此复选框的用途。 标签可以选择性地包含以下类型的GitHub风格的Markdown:粗体、斜体、删除线、内联代码、链接和图片。图片显示为图标,最大高度等于字体高度。 不支持的Markdown元素会被解包,因此只有它们的子元素(文本内容)会呈现。通过反斜杠转义不支持的元素,将其显示为字面字符。例如, "1\. 不是一个有序列表"。 有关其他支持的Markdown指令,请参见st.markdown的body参数。 出于可访问性原因,您不应设置空标签,但可以根据需要使用label_visibility隐藏它。将来,我们可能会通过引发异常来禁止空标签。 |
value (bool) | 在首次渲染时预选复选框。这将在内部转换为布尔值。 |
key (str or int) | 一个可选的字符串或整数,用作小部件的唯一键。 如果省略,将根据小部件的内容生成一个键。 任何两个小部件都不能有相同的键。 |
help (str) | 一个可选的工具提示,显示在小部件标签旁边。 Streamlit 仅在 label_visibility="visible" 时显示工具提示。 |
on_change (callable) | 当此复选框的值发生变化时调用的可选回调函数。 |
args (tuple) | 传递给回调函数的可选参数元组。 |
kwargs (dict) | 一个可选的字典,用于传递给回调函数。 |
disabled (bool) | 一个可选的布尔值,如果设置为True,则禁用复选框。 默认值为False。 |
label_visibility ("visible", "hidden", or "collapsed") | 标签的可见性。默认是"visible"。如果这是"hidden",Streamlit会显示一个空的占位符而不是标签,这有助于保持小部件与其他小部件对齐。如果这是"collapsed",Streamlit不会显示标签或占位符。 |
返回 | |
(bool) | 复选框是否被选中。 |
示例
import streamlit as st agree = st.checkbox("I agree") if agree: st.write("Great!")
Featured videos
查看我们的视频,了解如何使用Streamlit的核心功能之一,复选框!☑
在下面的视频中,我们将更进一步,学习如何结合button、checkbox和radio button!
还有问题吗?
我们的 论坛 充满了有用的信息和Streamlit专家。