显示一个表单提交按钮。

当点击此按钮时,表单内的所有小部件值将从用户的浏览器批量发送到您的Streamlit服务器。

每个表单必须至少有一个st.form_submit_button。一个st.form_submit_button不能存在于表单之外。

有关表单的更多信息,请查看我们的文档

函数签名[source]

st.form_submit_button(label="提交", help=None, on_click=None, args=None, kwargs=None, *, type="secondary", icon=None, disabled=False, use_container_width=False)

参数

label (str)

一个简短的标签,向用户解释此按钮的用途。 默认为“提交”。

帮助 (str 或 None)

当鼠标悬停在按钮上时显示的工具提示。 默认为 None。

on_click (callable)

当点击此按钮时调用的可选回调函数。

args (tuple)

传递给回调函数的可选参数元组。

kwargs (dict)

一个可选的字典,用于传递给回调函数。

type ("primary", "secondary", or "tertiary")

一个可选的字符串,用于指定按钮类型。可以是以下之一:

  • "primary": 按钮的背景是应用程序的主色调,用于额外的强调。
  • "secondary" (默认): 按钮的背景与应用程序的背景颜色协调,用于正常的强调。
  • "tertiary": 按钮是纯文本,没有边框或背景,用于微妙的强调。

icon (str or None)

一个可选的emoji或图标,显示在按钮标签旁边。如果iconNone(默认),则不显示图标。如果icon是一个 字符串,以下选项是有效的:

  • 一个单字符的emoji。例如,你可以设置icon="🚨"icon="🔥"。不支持emoji短代码。

  • 来自Material Symbols库(圆角风格)的图标,格式为 ":material/icon_name:",其中"icon_name"是图标名称 的蛇形命名。

    例如,icon=":material/thumb_up:"将显示 Thumb Up图标。在Material Symbols 字体库中查找更多图标。

disabled (bool)

是否禁用按钮。如果为False(默认),用户可以与按钮交互。如果为True,按钮将变灰且无法点击。

如果表单中的第一个st.form_submit_button被禁用,表单将覆盖提交行为,使用enter_to_submit=False

use_container_width (bool)

是否将按钮的宽度扩展到其父容器的宽度。 如果 use_container_widthFalse(默认),Streamlit 会调整按钮的大小以适应其内容。如果 use_container_widthTrue,按钮的宽度将与其父容器的宽度匹配。

在这两种情况下,如果按钮的内容比父容器宽,内容将换行。

返回

(bool)

如果按钮被点击则为True。

forum

还有问题吗?

我们的 论坛 充满了有用的信息和Streamlit专家。