---
title: "Progress"
description: "A progress bar with a label and a note."
---

> Documentation Index
> Fetch the complete documentation index at: https://gistui.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Progress

```gistui
root = Stack(Progress(72, "Onboarding", note:"18 of 25 steps"), Progress(4.2, "Storage", max:5, note:"4.2 of 5 GB", tone:warning))
```

## Signature

This is the line a model reads in the system prompt.

```gistui
Progress(value:num, label?, max:num, note:str, tone:Tone)
```

- **Group:** Data
- **Children:** No
- **Positional arguments:** `value`, `label?` (a trailing `?` means it may be left out)

## Props

| Prop | Type | How to write it | Notes |
|---|---|---|---|
| `value` | number | positional, required |  |
| `label` | string | positional, optional |  |
| `max` | number | named: `max:…` | Default `100`. |
| `note` | string | named: `note:…` |  |
| `tone` | `neutral` · `info` · `success` · `warning` · `danger` · `accent` | named: `tone:…` | Also accepts `error`, `red`, `green`, `blue`, `yellow`, `primary`. |

## Use your own component

Keep the name and schema, swap what is drawn. The prompt and the model's output do not change.

### React

```tsx
import { ui } from "@gistui/react/ui";

const lib = ui.extend({ Progress: MyProgress });
<GistUI library={lib} stream={response.body} />;
```
### Vue

```vue
<GistUI :source="answer" :components="{ Progress: MyProgress }" />
```
### Svelte

```svelte
<GistUI source={answer} components={{ Progress: MyProgress }} />
```
### Solid

```tsx
<GistUI source={answer()} components={{ Progress: MyProgress }} />
```
### Vanilla

```ts
import { ui } from "@gistui/vanilla/ui";

const lib = ui.extend({ Progress: (ctx) => ({ el: myElement(ctx) }) });
```

See [Custom components](/docs/guides/custom-components/) for the full contract. Style hook: `[data-gistui="Progress"]`.

Source: https://gistui.com/docs/components/data/progress/index.mdx