# Progress
## Introduction
This Supervisely widget allows you to display the progress of a task or operation. It is a useful widget for applications that involve long-running processes or tasks that take time to complete.
With the `Progress Bar` widget, you can easily create a progress bar that updates in real-time or update the progress bar dynamically as a task progresses, giving users a clear indication of how much time is left until the task is complete.
The Progress Bar Widget can be customized to show progress as percents or values.
## Function signature
```python
Progress(
message=None,
show_percents=False,
hide_on_finish=True,
widget_id=None,
)
```
## Parameters
| Parameters | Type | Description |
| :--------------: | :--: | :-------------------------: |
| message | str | Progress bar message |
| show\_percents | bool | Show progress in percents |
| hide\_on\_finish | bool | Hide progress bar on finish |
| widget\_id | str | ID of the widget |
### message
Progress bar message.
**type:** `str`
**default value:** `None`
```python
progress = Progress(message="My progress message")
```
### show\_percents
Show progress in percents.
**type:** `bool`
**default value:** `False`
```python
progress = Progress(show_percents=True)
```
### hide\_on\_finish
Hide progress bar on finish
**type:** `bool`
**default value:** `True`
```python
progress = Progress(hide_on_finish=True)
```
### widget\_id
ID of the widget.
**type:** `str`
**default value:** `None`
## Mini App Example
You can find this example in our Github repository:
[ui-widgets-demos/status elements/001\_progress\_bar/src/main.py](https://github.com/supervisely-ecosystem/ui-widgets-demos/blob/master/status%20elements/001_progress_bar/src/main.py)
#### Import libraries
```python
import os
from time import sleep
import supervisely as sly
from dotenv import load_dotenv
from supervisely.app.widgets import Card, Container
```
### Init API client
Init API for communicating with Supervisely Instance. First, we load environment variables with credentials:
```python
load_dotenv("local.env")
load_dotenv(os.path.expanduser("~/supervisely.env"))
api = sly.Api()
```
### Initialize `Progress Bar`, `Text` and `Button` widgets
```python
progress_bar = sly.app.widgets.Progress()
start_btn = sly.app.widgets.Button(text="Start", icon="zmdi zmdi-play")
finish_msg = sly.app.widgets.Text(status="success")
```
### Create app layout
Prepare a layout for app using `Card` widget with the `content` parameter and place 3 widgets that we've just created in the `Container` widget. Place order in the `Container` is important, we want the finish message text to be displayed below the progress bar button.
```python
card = Card(
title="Progress Bar",
description="👉 Click on the button to start",
content=Container([progress_bar, start_btn, finish_msg]),
)
layout = Container(widgets=[card], direction="vertical")
```
### Create app using layout
Create an app object with layout parameter.
```python
app = sly.Application(layout=layout)
```
Our app layout is ready. Progress bar will appear after pressing the `Start` button.
### Start progress with button click
Use the decorator as shown below to handle button click. `Progress Bar` will be updating itself (`pbar.update(1)`) every half second by 1 point as specified in `sleep` function until it reaches `total` 10.
```python
@start_btn.click
def start_progress():
with progress_bar(message=f"Processing items...", total=10) as pbar:
for _ in range(10):
sleep(0.5)
pbar.update(1)
finish_msg.text = "Finished"
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://developer.supervisely.com/app-development/widgets/status-elements/progressbar.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
