Component

Progress

Shows the completion progress of a task.

Install

Run the CLI to copy the source into your project.

pnpm dlx @stalk-ui/cli add @stalk-ui/progress

Examples

Live previews render through the docs app's PandaCSS codegen.

Theme
<Progress aria-label="Upload" value={42} />
Theme
<Progress aria-label="Sync" max={200} value={120} size="lg" />
Theme
<Progress aria-label="Loading" />
Theme
<Progress aria-label="Capacity" shape="circular" showValue value={72} />

Props

Public component props extracted from the source TypeScript types.

PropTypeRequiredDefaultDescription
`size``ProgressSize`No--
`shape``ProgressShape`No-Geometry: linear track (default) or circular gauge.
`showValue``boolean`No-Render the current value in the center of a circular gauge.
`formatValue``(value: number, max: number) => string`No-Format the centered value read-out (default: whole percent).

Variants

Variant axes exposed by the underlying PandaCSS recipe or slot recipe.

VariantValues
`shape``linear`, `circular`
`size``sm`, `md`, `lg`

Registry

Files this component contributes to your registry install.

  • Manifest: `/r/progress.json`
  • Recipe: `progress`
  • Files: `src/components/ui/progress.tsx`