Skip to content
FeedbackInteractive playground

Progress

Show how much of a task is complete.

Preparing the playground…
Text and Markdown example
Progress · Example
1<Progress value={65} max={100} aria-label="Project progress" style={{width:320}} />
Read documentation in Markdown

How to use it

Use a value between 0 and max. Progress must represent real data; do not use it as a simulated timer.

Import

React / Next.js
1import { Progress } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

PropertyTypeDescription
aria-labelstringAccessible name of the control.
asChildbooleanApply props and behavior to a single compatible child element.
childrenReactNodeContent or child elements of the component.
classNamestringAdditional CSS classes to customize the element.
defaultCheckedbooleanInitial selection of the control.
defaultValuestring | number | readonly string[]Initial value when the component manages its own state.
getValueLabel((value: number, max: number) => string)Configures getValueLabel. The type describes the supported values and structure.
idstringElement identifier; associates labels and descriptions.
indicatorClassNamestringCSS classes for the specified element.
maxnumberMaximum allowed value.
onChangeChangeEventHandler<HTMLDivElement, Element>Change event. Check the type: some controls return an object, others a DOM event.
onClickMouseEventHandler<HTMLDivElement>Action performed when the element is activated.
onSubmitSubmitEventHandler<HTMLDivElement>Form submission event.
roleAriaRoleSemantic role of the element. Keep the default role unless a change is justified.
size"default" | "sm" | "lg"Visual size of the component.
styleCSSPropertiesReact inline styles.
tabIndexnumberKeyboard focus order and availability.
titlestringTitle or supplementary information.
valuenumber | nullControlled value. Update it from the change callback.

TypeScript definition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

Progress19 properties
Progress · TypeScript
1Progress: React.ForwardRefExoticComponent<ProgressProps & React.RefAttributes<HTMLDivElement>>
API generated from @kivora/nextjs 0.2.0View package