data/develop/api-reference/status/_index.md

metadata

title: Display progress and status
slug: /develop/api-reference/status

Display progress and status

Streamlit provides a few methods that allow you to add animation to your apps. These animations include progress bars, status messages (like warnings), and celebratory balloons.

Animated status elements

Progress bar

Display a progress bar.

for i in range(101):
  st.progress(i)
  do_something_slow()

Spinner

Temporarily displays a message while executing a block of code.

with st.spinner("Please wait..."):
  do_something_slow()

Status container

Display output of long-running tasks in a container.

with st.status('Running'):
  do_something_slow()

Toast

Briefly displays a toast message in the bottom-right corner.

st.toast('Butter!', icon='🧈')

Balloons

Display celebratory balloons!

st.balloons()

Snowflakes

Display celebratory snowflakes!

st.snow()

Simple callout messages

Success box

Display a success message.

st.success("Match found!")

Info box

Display an informational message.

st.info("Dataset is updated every day at midnight.")

Warning box

Display warning message.

st.warning("Unable to fetch image. Skipping...")

Error box

Display error message.

st.error("We encountered an error")

Exception output

Display an exception.

e = RuntimeError("This is an exception of type RuntimeError")
st.exception(e)

Stqdm

The simplest way to handle a progress bar in streamlit app. Created by @Wirg.

from stqdm import stqdm

for _ in stqdm(range(50)):
    sleep(0.5)

Custom notification box

A custom notification box with the ability to close it out. Created by @Socvest.

from streamlit_custom_notification_box import custom_notification_box

styles = {'material-icons':{'color': 'red'}, 'text-icon-link-close-container': {'box-shadow': '#3896de 0px 4px'}, 'notification-text': {'':''}, 'close-button':{'':''}, 'link':{'':''}}
custom_notification_box(icon='info', textDisplay='We are almost done with your registration...', externalLink='more info', url='#', styles=styles, key="foo")

Streamlit Extras

A library with useful Streamlit extras. Created by @arnaudmiribel.

from streamlit_extras.let_it_rain import rain

rain(emoji="🎈", font_size=54,
  falling_speed=5, animation_length="infinite",)