structyl

Progress

stable

Displays an indicator showing the completion progress of a task.

Basic usage

Examples

Indeterminate

Pass null or undefined as value to render an indeterminate progress bar.

Loading…

Determinate and indeterminate

Use value for known progress, or null for pending work without a measured value.

Semantic colors

Color prop applies semantic tints to the progress bar fill.

Features

  • Smooth animated fill.
  • Supports indeterminate state.

Installation

bash
pnpm dlx structyl add progress

API Reference

Progress

A linear progress bar. Has role="progressbar".

PropTypeDefault
valuenumber | null

Current value (0–max). Pass null for indeterminate.

maxnumber

Maximum value.

100
getValueLabel(value, max) => string

Returns the localized aria-valuetext label.

classNamestring

Additional Tailwind classes, merged with the component defaults.

Progress | structyl