Overview
Progress displays an indicator showing the completion progress of a task, typically displayed as a progress bar.Features
- Provides context for assistive technology to read the progress of a task
- Supports indeterminate state for when progress is unknown
Installation
Anatomy
API Reference
Root
Contains all the parts of a progress bar.number | null
The progress value. If
null, the progress is indeterminate.number
default:"100"
The maximum progress value.
(value: number, max: number) => string
A function to get the accessible label text representing the current value in a human-readable format. If not provided, the value label will be read as the numeric value as a percentage of the max value.
Indicator
Used to show the progress visually. It also makes progress accessible to assistive technologies.Examples
Basic Usage
Indeterminate State
Custom Value Label
Data Attributes
Root
data-state-"complete","loading", or"indeterminate"data-value- The current valuedata-max- The max value
Indicator
data-state-"complete","loading", or"indeterminate"data-value- The current valuedata-max- The max value
Accessibility
Adheres to theprogressbar role requirements.