Skip to content

Progress

Displays an indicator showing the completion progress of a task, typically displayed as a progress bar.

Installation

npm i @huin-core/react-progress

API Reference

Progress

PropTypeDescription
asChildbooleanWhen set to true, renders the component as its child element, inheriting the child's styles and behavior.
valuenumberRepresents the current value or state of the component, which can be used to bind or track its data over time.
maxnumberDefines the maximum allowed value or limit for the component, ensuring that it does not exceed a specified threshold.
getValueLabelfunctionA 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.

ProgressIndicator

PropTypeDescription
asChildbooleanWhen set to true, renders the component as its child element, inheriting the child's styles and behavior.