Skip to content
Agent UI
PrimitivesProgress

Progress

Native progress indicator for determinate or indeterminate operations. Import from @agent-ui/react or a direct subpath. Tailwind CSS v4 theme tokens are required.

Progress ships with a full API table, a copyable example, and accessibility notes.

tsx

Indexing files · 64%

Installation

Install the package once, then import Progress from its direct entry point or from the root.

bash
pnpm add @agent-ui/react
tsx
import { Progress } from "@agent-ui/react/progress";

Tailwind CSS v4 users: add @source "../node_modules/@agent-ui/react/src" to the global stylesheet so the library utilities are generated.

Usage

The example below is the same code that renders the preview. Copy it, swap in your own handlers, and ship.

tsx
import { Progress } from "@agent-ui/react";
 
<Progress value={64} aria-label="Indexing documents" />

API reference

Every prop Progress accepts, its type, default, and behaviour.

API reference for this component
NameTypeDefaultDescription
valuenumber | string—Configuration exposed through the component's public React props.
maxnumber—Progress maximum.
aria-labelReact prop—Configuration exposed through the component's public React props.

Accessibility

Uses native HTML semantics, keyboard controls and visible focus styles where applicable.
Use it with the rest of the library

Progress composes with MessageList, ChatShell, useChat, and the provider compose blocks. Browse the full reference or see all components in the gallery.

3 lines · copy-ready