StateBar

Overview

Statebar is a custom widget to provide easy to use state bars in the pysepal framework. it inherits from the SepalWidget class. any argument from the original SystemBar ipyvuetify class can be used to complement it.

from pysepal import sepalwidgets as sw

# correct colors for the documentation
# set to dark in SEPAL by default
import ipyvuetify as v
v.theme.dark = False

statebar = sw.StateBar()
statebar

/home/docs/checkouts/readthedocs.org/user_builds/sepal-ui/envs/latest/lib/python3.10/site-packages/google/api_core/_python_version_support.py:273: FutureWarning: You are using a Python version (3.10.19) which Google will stop supporting in new releases of google.api_core once it reaches its end of life (2026-10-04). Please upgrade to the latest Python version, or at least Python 3.11, to continue receiving updates for google.api_core past that date.
  warnings.warn(message, FutureWarning)

Methods

State bar can be stopped using the following code. The msg can be changed according to your need.

Tip

You can also change the message without stopping the loading by omitting the second parameter

from pysepal import sepalwidgets as sw

# correct colors for the documentation
# set to dark in SEPAL by default
import ipyvuetify as v
v.theme.dark = False

statebar = sw.StateBar()
statebar.add_msg('ongoing', True)

Note

More information can be found here.