Skip to main content

Starwind UI v3.0 beta is now available! Read the migration guide

Installation

Framework Availability

Astro Available React Available

Progress is available for Astro and React.

Usage

Variants

Indeterminate

When you need to show a loading state without a specific value, omit the value prop to create an indeterminate progress bar.

Dynamic Updates

The Progress component can be updated dynamically by changing the data-value attribute. This is useful for showing real-time progress like file uploads, form completion, or step-by-step processes.

Interactive Progress Example

API Reference

Styled Component API

These props are added or materially changed by the installed Astro styled component. Standard HTML attributes remain available through the inherited interfaces noted below. Follow the Primitive and Runtime links for lower-level behavior props.

Progress

Inherits div attributes. Omits `value`.

Contains the following additional props:

Prop Type Default Toggle details
label string
Description
Provides accessible text for the component.
Classification
Wrapper prop
max number 100
Description
Sets the maximum accepted value.
Classification
Wrapper prop
min number 0
Description
Sets the minimum accepted value.
Classification
Wrapper prop
value number | null null
Description
Controls or identifies the component value.
Classification
Wrapper prop
variant "default" | "primary" | "secondary" | "info" | "success" | "warning" | "error" "default"
Description
Selects the component's visual variant.
Classification
Wrapper prop

Primitive And Runtime API

Use these references when you need the lower-level behavior APIs behind Progress.

Primitive API

Runtime API

Progress primitive
createProgress from @starwind-ui/runtime/progress

Changelog

v2.0.0

  • Rebuilt Progress on Starwind Runtime for determinate and indeterminate state.
  • See the Progress Primitive for the underlying unstyled anatomy and behavior API.

v1.1.3

  • Refactor tailwind variants functions into separate variants.ts file

v1.1.1

  • Add starwind:init event listener to enable initialization of additional Progress loaded after an initial page load, such as when using server islands

v1.1.0

  • Add data-slot attribute to enable global styling updates

v1.0.0

  • Initial release with starwind v1.7.0