# st.form_submit_button

Source: https://docs.streamlit.io/develop/api-reference/execution-flow/st.form_submit_button

* Function signature:

   ```python
   st.form_submit_button(label="Submit", help=None, on_click=None, args=None, kwargs=None, *, key=None, type="secondary", icon=None, icon_position="left", disabled=False, use_container_width=None, width="content", shortcut=None, wrap=None)
   ```

* Parameters:

   | name | type | default | description |
   |---|---|---|---|
   | label | str |  | A short label explaining to the user what this button is for. This defaults to "Submit". 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. Common block-level Markdown (headings, lists, blockquotes) is automatically escaped and displays as literal text in labels. See the body parameter of st.markdown for additional, supported Markdown directives. |
   | help | str or None |  | A tooltip that gets displayed when the button is hovered over. If this is None (default), no tooltip is displayed. The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the body parameter of st.markdown. |
   | on_click | callable |  | An optional callback invoked when this button is clicked. |
   | args | list or tuple |  | An optional list or tuple of args to pass to the callback. |
   | kwargs | dict |  | An optional dict of kwargs to pass to the callback. |
   | key | str, int, or None |  | An optional string or integer to use as the unique key for the widget. If this is None (default), a key will be generated for the widget based on the values of the other parameters. No two widgets may have the same key. Assigning a key stabilizes the widget's identity and preserves its state across reruns even when other parameters change. A key lets you access the widget's value via st.session_state[key] (read-only). For more details, see Widget behavior. Additionally, if key is provided, it will be used as a CSS class name prefixed with st-key-. |
   | type | "primary", "secondary", or "tertiary" |  | An optional string that specifies the button type. This can be one of the following:  "primary": The button's background is the app's primary color for additional emphasis. "secondary" (default): The button's background coordinates with the app's background color for normal emphasis. "tertiary": The button is plain text without a border or background for subtlety. |
   | icon | str or None |  | An optional emoji or icon to display next to the button label. If icon is None (default), no icon is displayed. If icon is a string, the following options are valid:  A single-character emoji. For example, you can set icon="🚨" or icon="🔥". Emoji short codes are not supported.  An icon from the Material Symbols library (rounded style) in the format ":material/icon_name:" where "icon_name" is the name of the icon in snake case. For example, icon=":material/thumb_up:" will display the Thumb Up icon. Find additional icons in the Material Symbols font library.  "spinner": Displays a spinner as an icon. |
   | icon_position | "left" or "right" |  | The position of the icon relative to the button label. This defaults to "left". |
   | disabled | bool |  | Whether to disable the button. If this is False (default), the user can interact with the button. If this is True, the button is grayed-out and can't be clicked. If the first st.form_submit_button in the form is disabled, the form will override submission behavior with enter_to_submit=False. |
   | use_container_width | bool |  | Whether to expand the button's width to fill its parent container. If use_container_width is False (default), Streamlit sizes the button to fit its contents. If use_container_width is True, the width of the button matches its parent container. In both cases, if the contents of the button are wider than the parent container, the contents will line wrap. |
   | width | "content", "stretch", or int |  | The width of the button. This can be one of the following:  "content" (default): The width of the button matches the width of its content, but doesn't exceed the width of the parent container. "stretch": The width of the button matches the width of the parent container. An integer specifying the width in pixels: The button has a fixed width. If the specified width is greater than the width of the parent container, the width of the button matches the width of the parent container. |
   | shortcut | str or None |  | An optional keyboard shortcut that triggers the button. This can be one of the following strings:  A single alphanumeric key like "K" or "4". A function key like "F11". A special key like "Enter", "Esc", or "Tab". Any of the above combined with modifiers. For example, you can use "Ctrl+K" or "Cmd+Shift+O".   Important The keys "C" and "R" are reserved and can't be used, even with modifiers. Punctuation keys like "." and "," aren't currently supported. Some combinations such as "Ctrl+T", "Ctrl+W", "Ctrl+PageUp", "Ctrl+PageDown", and "F11" are reserved by the browser or operating system and may never reach Streamlit.  For a list of supported keys and modifiers, see the documentation for st.button. |
   | wrap | bool or None |  | Whether the button label can wrap onto multiple lines. This can be one of the following:  None (default): Streamlit decides based on the surrounding layout. Inside a horizontal container or when the button is a direct child of an st.columns column, the button keeps its standard, single-row height and truncates an overflowing label with an ellipsis; in other layouts, the label wraps onto additional lines. A form is a layout boundary, so placing the form itself in a column does not make the submit button a direct column child. True: If the label is too wide for the button, it wraps onto additional lines and the button grows taller. False: The button keeps its standard, single-row height. A label that is too wide is truncated with an ellipsis.  When a single-row label is truncated with an ellipsis and no help is set, hovering reveals the full label. Icons and keyboard shortcuts remain visible. |

* Returns: bool

    True if the button was clicked.
