st.success

st.info

CALLOUTS

st.warning

st.error

st.exception

OTHER

st.progress

st.spinner

st.status

st.toast

st.balloons

st.snow

Status elements

Sequence of all <tt class="docutils literal">st.button</tt> and <tt class="docutils literal">st.form_submit_button</tt> widgets.

button

Sequence of all <tt class="docutils literal">st.button</tt> and <tt class="docutils literal">st.form_submit_button</tt>
widgets. Individual widgets can be accessed from a WidgetList by
index (order on the page) or key. For example, <tt class="docutils literal">at.button[0]</tt> for
the first widget or <tt class="docutils literal">at.button(key=&quot;my_key&quot;)</tt> for a widget with a
given key.

Sequence of all <tt class="docutils literal">st.caption</tt> elements.

caption

Sequence of all <tt class="docutils literal">st.caption</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.caption[0]</tt> for the first element. Caption is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.chat_input</tt> widgets.

chat_input

Sequence of all <tt class="docutils literal">st.chat_input</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.chat_input[0]</tt> for the first widget or
<tt class="docutils literal">at.chat_input(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.chat_message</tt> elements.

chat_message

Sequence of all <tt class="docutils literal">st.chat_message</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.chat_message[0]</tt> for the first element. ChatMessage
is an extension of the Block class.

Sequence of all <tt class="docutils literal">st.checkbox</tt> widgets.

checkbox

Sequence of all <tt class="docutils literal">st.checkbox</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.checkbox[0]</tt> for the first widget or
<tt class="docutils literal">at.checkbox(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.code</tt> elements.

code

Sequence of all <tt class="docutils literal">st.code</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.code[0]</tt> for the first element. Code is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.color_picker</tt> widgets.

color_picker

Sequence of all <tt class="docutils literal">st.color_picker</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.color_picker[0]</tt> for the first widget or
<tt class="docutils literal">at.color_picker(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all columns within <tt class="docutils literal">st.columns</tt> elements.
Each column within a single <tt class="docutils literal">st.columns</tt> will be returned as a
separate Column in the Sequence.

columns

Sequence of all columns within <tt class="docutils literal">st.columns</tt> elements. Individual
columns can be accessed from an ElementList by index (order on the
page). For example, <tt class="docutils literal">at.columns[0]</tt> for the first column. Column
is an extension of the Block class.

Sequence of all <tt class="docutils literal">st.dataframe</tt> elements.

dataframe

Sequence of all <tt class="docutils literal">st.dataframe</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.dataframe[0]</tt> for the first element. Dataframe is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.date_input</tt> widgets.

date_input

Sequence of all <tt class="docutils literal">st.date_input</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.date_input[0]</tt> for the first widget or
<tt class="docutils literal">at.date_input(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.divider</tt> elements.

divider

Sequence of all <tt class="docutils literal">st.divider</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.divider[0]</tt> for the first element. Divider is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.error</tt> elements.

error

Sequence of all <tt class="docutils literal">st.error</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.error[0]</tt> for the first element. Error is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.exception</tt> elements.

exception

Sequence of all <tt class="docutils literal">st.exception</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.exception[0]</tt> for the first element. Exception is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.expander</tt> elements.

expander

Sequence of all <tt class="docutils literal">st.expander</tt> elements. Individual elements can be
accessed from a Sequence by index (order on the page). For
example, <tt class="docutils literal">at.expander[0]</tt> for the first element. Expandable is an
extension of the Block class.

Path to a script file. The path should be absolute or relative to
the file calling <tt class="docutils literal">.from_file</tt>.

script_path

Default time in seconds before a script run is timed out. Can be
overridden for individual <tt class="docutils literal">.run()</tt> calls.

default_timeout

Create an instance of <tt class="docutils literal">AppTest</tt> to simulate an app page defined within a file.
This option is most convenient for CI workflows and testing of
published apps. The script must be executable on its own and so must
contain all necessary imports.

from_file

A simulated Streamlit app for testing. The simulated app can be
executed via <tt class="docutils literal">.run()</tt>.

A function whose body will be used as a script. Must be runnable
in isolation, so it must include any necessary imports.

script

An optional tuple of args to pass to the script function.

args

An optional dict of kwargs to pass to the script function.

kwargs

Create an instance of <tt class="docutils literal">AppTest</tt> to simulate an app page defined within a function.
This is similar to <tt class="docutils literal">AppTest.from_string()</tt>, but more convenient to
write with IDE assistance. The script must be executable on its own and
so must contain all necessary imports.

from_function

The string contents of the script to be run.

Create an instance of <tt class="docutils literal">AppTest</tt> to simulate an app page defined within a string.
This is useful for testing short scripts that fit comfortably as an
inline string in the test itself, without having to create a separate
file for it. The script must be executable on its own and so must
contain all necessary imports.

from_string

An element attribute of <tt class="docutils literal">AppTest</tt>. For example, &quot;button&quot;,
&quot;caption&quot;, or &quot;chat_input&quot;.

element_type

Get elements or widgets of the specified type.
This method returns the collection of all elements or widgets of
the specified type on the current page. Retrieve a specific element by
using its index (order on page) or key lookup.

Sequence of elements of the given type. Individual elements can
be accessed from a Sequence by index (order on the page). When
getting and <tt class="docutils literal">element_type</tt> that is a widget, individual widgets
can be accessed by key. For example, <tt class="docutils literal">at.get(&quot;text&quot;)[0]</tt> for the
first <tt class="docutils literal">st.text</tt> element or <tt class="docutils literal">at.get(&quot;slider&quot;)(key=&quot;my_key&quot;)</tt> for
the <tt class="docutils literal">st.slider</tt> widget with a given key.

Sequence of all <tt class="docutils literal">st.header</tt> elements.

header

Sequence of all <tt class="docutils literal">st.header</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.header[0]</tt> for the first element. Header is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.info</tt> elements.

info

Sequence of all <tt class="docutils literal">st.info</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.info[0]</tt> for the first element. Info is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.json</tt> elements.

json

Sequence of all <tt class="docutils literal">st.json</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.json[0]</tt> for the first element. Json is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.latex</tt> elements.

latex

Sequence of all <tt class="docutils literal">st.latex</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.latex[0]</tt> for the first element. Latex is an
extension of the Element class.

Sequence of elements within the main body of the app.

main

A container of elements. Block can be queried for elements in the
same manner as <tt class="docutils literal">AppTest</tt>. For example, <tt class="docutils literal">Block.checkbox</tt> will
return all <tt class="docutils literal">st.checkbox</tt> within the associated container.

Sequence of all <tt class="docutils literal">st.markdown</tt> elements.

markdown

Sequence of all <tt class="docutils literal">st.markdown</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.markdown[0]</tt> for the first element. Markdown is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.metric</tt> elements.

metric

Sequence of all <tt class="docutils literal">st.metric</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.metric[0]</tt> for the first element. Metric is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.multiselect</tt> widgets.

multiselect

Sequence of all <tt class="docutils literal">st.multiselect</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.multiselect[0]</tt> for the first widget or
<tt class="docutils literal">at.multiselect(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.number_input</tt> widgets.

number_input

Sequence of all <tt class="docutils literal">st.number_input</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.number_input[0]</tt> for the first widget or
<tt class="docutils literal">at.number_input(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.radio</tt> widgets.

radio

Sequence of all <tt class="docutils literal">st.radio</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.radio[0]</tt> for the first widget or
<tt class="docutils literal">at.radio(key=&quot;my_key&quot;)</tt> for a widget with a given key.

The maximum number of seconds to run the script. None means
use the default timeout set for the instance of <tt class="docutils literal">AppTest</tt>.

timeout

Run the script from the current state.
This is equivalent to manually rerunning the app or the rerun that
occurs upon user interaction. <tt class="docutils literal">AppTest.run()</tt> must be manually called
after updating a widget value or switching pages as script reruns do
not occur automatically as they do for live-running Streamlit apps.

Sequence of all <tt class="docutils literal">st.select_slider</tt> widgets.

select_slider

Sequence of all <tt class="docutils literal">st.select_slider</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.select_slider[0]</tt> for the first widget or
<tt class="docutils literal">at.select_slider(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.selectbox</tt> widgets.

selectbox

Sequence of all <tt class="docutils literal">st.selectbox</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.selectbox[0]</tt> for the first widget or
<tt class="docutils literal">at.selectbox(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all elements within <tt class="docutils literal">st.sidebar</tt>.

sidebar

Sequence of all <tt class="docutils literal">st.slider</tt> widgets.

slider

Sequence of all <tt class="docutils literal">st.slider</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.slider[0]</tt> for the first widget or
<tt class="docutils literal">at.slider(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.status</tt> elements.

status

Sequence of all <tt class="docutils literal">st.status</tt> elements. Individual elements can be
accessed from a Sequence by index (order on the page). For
example, <tt class="docutils literal">at.status[0]</tt> for the first element. Status is an
extension of the Block class.

Sequence of all <tt class="docutils literal">st.subheader</tt> elements.

subheader

Sequence of all <tt class="docutils literal">st.subheader</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.subheader[0]</tt> for the first element. Subheader is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.success</tt> elements.

success

Sequence of all <tt class="docutils literal">st.success</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.success[0]</tt> for the first element. Success is an
extension of the Element class.

Path of the page to switch to. The path must be relative to the
main script's location (e.g. <tt class="docutils literal">&quot;pages/my_page.py&quot;</tt>).

page_path

Switch to another page of the app.
This method does not automatically rerun the app. Use a follow-up call
to <tt class="docutils literal">AppTest.run()</tt> to obtain the elements on the selected page.

switch_page

Sequence of all <tt class="docutils literal">st.table</tt> elements.

table

Sequence of all <tt class="docutils literal">st.table</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.table[0]</tt> for the first element. Table is an
extension of the Element class.

Sequence of all tabs within <tt class="docutils literal">st.tabs</tt> elements.
Each tab within a single <tt class="docutils literal">st.tabs</tt> will be returned as a separate Tab
in the Sequence. Additionally, the tab labels are forwarded to each
Tab element as a property. For example, <tt class="docutils literal">st.tabs(&quot;A&quot;,&quot;B&quot;)</tt> will
yield two Tab objects, with <tt class="docutils literal">Tab.label</tt> returning &quot;A&quot; and &quot;B&quot;,
respectively.

tabs

Sequence of all tabs within <tt class="docutils literal">st.tabs</tt> elements. Individual
tabs can be accessed from an ElementList by index (order on the
page). For example, <tt class="docutils literal">at.tabs[0]</tt> for the first tab. Tab is an
extension of the Block class.

Sequence of all <tt class="docutils literal">st.text</tt> elements.

text

Sequence of all <tt class="docutils literal">st.text</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.text[0]</tt> for the first element. Text is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.text_area</tt> widgets.

text_area

Sequence of all <tt class="docutils literal">st.text_area</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.text_area[0]</tt> for the first widget or
<tt class="docutils literal">at.text_area(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.text_input</tt> widgets.

text_input

Sequence of all <tt class="docutils literal">st.text_input</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.text_input[0]</tt> for the first widget or
<tt class="docutils literal">at.text_input(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.time_input</tt> widgets.

time_input

Sequence of all <tt class="docutils literal">st.time_input</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.time_input[0]</tt> for the first widget or
<tt class="docutils literal">at.time_input(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.title</tt> elements.

title

Sequence of all <tt class="docutils literal">st.title</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.title[0]</tt> for the first element. Title is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.toast</tt> elements.

toast

Sequence of all <tt class="docutils literal">st.toast</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.toast[0]</tt> for the first element. Toast is an
extension of the Element class.

Sequence of all <tt class="docutils literal">st.toggle</tt> widgets.

toggle

Sequence of all <tt class="docutils literal">st.toggle</tt> widgets. Individual widgets can
be accessed from a WidgetList by index (order on the page) or key.
For example, <tt class="docutils literal">at.toggle[0]</tt> for the first widget or
<tt class="docutils literal">at.toggle(key=&quot;my_key&quot;)</tt> for a widget with a given key.

Sequence of all <tt class="docutils literal">st.warning</tt> elements.

warning

Sequence of all <tt class="docutils literal">st.warning</tt> elements. Individual elements can be
accessed from an ElementList by index (order on the page). For
example, <tt class="docutils literal">at.warning[0]</tt> for the first element. Warning is an
extension of the Element class.

Arguments of the cached functions.

*args

Keyword arguments of the cached function.

**kwargs

Clear the cached function's associated cache.
If no arguments are passed, Streamlit will clear all values cached for
the function. If arguments are passed, Streamlit will clear the cached
value for these arguments only.

clear

data

The named dataset to concat. Optional. You can only pass in 1
dataset (including the one in the data parameter).

Concatenate a dataframe to the bottom of the current one.

add_rows

A new label of the status container. If None, the label is not
changed.

label

The new expanded state of the status container. If None,
the expanded state is not changed.

expanded

The new state of the status container. This mainly changes the
icon. If None, the state is not changed.

state

Update the status container.
Only specified arguments are updated. Container contents and unspecified
arguments remain unchanged.

update

The Altair chart object to display.

altair_chart

If True, set the chart width to the column width. This takes
precedence over Altair's native <tt class="docutils literal">width</tt> value.

use_container_width

The theme of the chart. Currently, we only support &quot;streamlit&quot; for the Streamlit
defined design or None to fallback to the default behavior of the library.

theme

Display a chart using the Altair library.

Column name to use for the x-axis. If None, uses the data index for the x-axis.

Column name(s) to use for the y-axis. If a Sequence of strings,
draws several series on the same chart by melting your wide-format
table into a long-format table behind the scenes. If None, draws
the data of all remaining columns as data series.

The color to use for different series in this chart.
For an area chart with just 1 series, this can be:
<ul class="simple">
<li>None, to use the default color.</li>
<li>A hex string like &quot;#ffaa00&quot; or &quot;#ffaa0088&quot;.</li>
<li>An RGB or RGBA tuple with the red, green, blue, and alpha
components specified as ints from 0 to 255 or floats from 0.0 to
1.0.</li>
</ul>
For an area chart with multiple series, where the dataframe is in
long format (that is, y is None or just one column), this can be:
<ul>
<li>None, to use the default colors.
</li>
<li>The name of a column in the dataset. Data points will be grouped
into series of the same color based on the value of this column.
In addition, if the values in this column match one of the color
formats above (hex string or color tuple), then that color will
be used.
For example: if the dataset has 1000 rows, but this column only
contains the values &quot;adult&quot;, &quot;child&quot;, and &quot;baby&quot;, then those 1000
datapoints will be grouped into three series whose colors will be
automatically selected from the default palette.
But, if for the same 1000-row dataset, this column contained
the values &quot;#ffaa00&quot;, &quot;#f0f&quot;, &quot;#0000ff&quot;, then then those 1000
datapoints would still be grouped into 3 series, but their
colors would be &quot;#ffaa00&quot;, &quot;#f0f&quot;, &quot;#0000ff&quot; this time around.
</li>
</ul>
For an area chart with multiple series, where the dataframe is in
wide format (that is, y is a Sequence of columns), this can be:
<ul class="simple">
<li>None, to use the default colors.</li>
<li>A list of string colors or color tuples to be used for each of
the series in the chart. This list should have the same length
as the number of y values (e.g. <tt class="docutils literal">color=[&quot;#fd0&quot;, &quot;#f0f&quot;, &quot;#04f&quot;]</tt>
for three lines).</li>
</ul>

color

The chart width in pixels. If 0, selects the width automatically.

width

The chart height in pixels. If 0, selects the height automatically.

height

If True, set the chart width to the column width. This takes
precedence over the width argument.

Display an area chart.
This is syntax-sugar around <tt class="docutils literal">st.altair_chart</tt>. The main difference
is this command uses the data's own column and indices to figure out
the chart's spec. As a result this is easier to use for many &quot;just plot
this&quot; scenarios, while being less customizable.
If <tt class="docutils literal">st.area_chart</tt> does not guess the data specification
correctly, try specifying your desired chart using <tt class="docutils literal">st.altair_chart</tt>.

Function signature[source]
st.success(body, *, icon=None)
Parameters
body (str)	The success text to display.
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 (outlined 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.

st.success

Example

Still have questions?