Hello there 👋

Thanks for stopping by! We use cookies to help us understand how you interact with our website.

By clicking “Accept all”, you consent to our use of cookies. For more information, please see our privacy policy.

st.success

Display a success message.

Function signature[source]

st.success(body, *, icon=None, width="stretch")

Parameters

body (str)

The text to display as GitHub-flavored Markdown. Syntax information can be found at: https://github.github.com/gfm.

See the body parameter of st.markdown for additional, supported Markdown directives.

icon (str, None)

An optional emoji or icon to display next to the alert. 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.

width (int or "stretch")

The desired width of the alert expressed in pixels. If this is "stretch" (default), Streamlit sets the width of the alert to match the width of the parent container. Otherwise, this must be an integer. If the specified width is greater than the width of the parent container, Streamlit sets the width of the alert to match the width of the parent container.

Example

import streamlit as st

st.success('This is a success message!', icon="✅")
Previous: Status elementsNext: st.info
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.