Documentation

Progress

Displays an indicator showing the completion progress of a task.

Examples

13%
13%
import { Progress } from 'kalki-design'

<Progress>Click me</Progress>

Installation

npx kalki-design add progress

Usage

import { Progress } from 'kalki-design'

export default function Example() {
  return <Progress />
}

API Reference

NameTypeDefaultDescription
NamevalueTypenumberDefaultDescriptionThe progress value.
NamemaxTypenumberDefault100DescriptionThe maximum progress value.
NamevariantType'default' | 'success' | 'warning' | 'error'Default'default'DescriptionVisual style of the progress bar.
NamesizeType'sm' | 'md' | 'lg'Default'md'DescriptionHeight of the linear progress track.
NameindeterminateTypebooleanDefaultfalseDescriptionWhether the progress is indeterminate.
NameshowLabelTypebooleanDefaultfalseDescriptionWhether to display the percentage label.
NamestripedTypebooleanDefaultfalseDescriptionAdds zebra stripes to the linear progress bar.