Display a link button element.
When clicked, a new tab will be opened to the specified URL. This will create a new session for the user if directed within the app.
| Function signature[source] | |
|---|---|
st.link_button(label, url, *, help=None, type="secondary", disabled=False, use_container_width=False) | |
| Parameters | |
label (str) | 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, and Links. Unsupported Markdown elements are unwrapped so only their children (text contents) render. Display unsupported elements as literal characters by backslash-escaping them. E.g., "1\. Not an ordered list". See the body parameter of st.markdown for additional, supported Markdown directives. |
url (str) | The url to be opened on user click |
help (str) | An optional tooltip that gets displayed when the button is hovered over. |
type ("secondary" or "primary") | An optional string that specifies the button type. Can be "primary" for a button with additional emphasis or "secondary" for a normal button. Defaults to "secondary". |
disabled (bool) | An optional boolean, which disables the link button if set to True. The default is 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. |
Example
import streamlit as st st.link_button("Go to gallery", "https://streamlit.io/gallery")
Still have questions?
Our forums are full of helpful information and Streamlit experts.