A short label explaining to the user what this button is for. 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.

The URL to open on user click.

An optional string to use for giving this element a stable identity. If this is None (default), the element's identity will be determined based on the values of the other parameters.

If on_click enables widget behavior and key is provided, Streamlit will register the key in Session State to store the button state. The button state is 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-.

How the button should respond to user interaction. This controls whether or not the button behaves like an input widget. This can be one of the following values:

• "ignore" (default): Streamlit opens the link in a new tab and doesn't rerun the app. The button won't behave like an input widget.
• "rerun": Streamlit opens the link in a new tab and reruns the app. In this case, st.link_button returns a Boolean value like st.button.
• A callable: Streamlit opens the link in a new tab, reruns the app, and executes the callable at the beginning of the rerun. In this case, st.link_button returns a Boolean value.

An optional list or tuple of args to pass to the callback when on_click is a callable. If on_click isn't a callable, this is ignored.

An optional dict of kwargs to pass to the callback when on_click is a callable. If on_click isn't a callable, this is ignored.

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.

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.

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.

The position of the icon relative to the button label. This defaults to "left".

An optional boolean that disables the link button if set to True. The default is False.

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.

The width of the link 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.

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".

For a list of supported keys and modifiers, see the documentation for st.button.