The visual color appearance of the component
Progress
Progress is used to display the progress status for a task that takes a long time or consists of several steps.
Import#
import { Progress } from '@chakra-ui/react'
Usage#
<Progress value={80} />
Progress with Stripe#
You can add hasStripe prop to any progress bar to apply a stripe via a CSS
gradient over the progress bar’s background color.
<Progress hasStripe value={64} />
Progress sizes#
There are two ways you can increase the height of the progress bar:
- You can add
sizeprop to increase the height of the progress bar. - You can also use the
heightprop to manually set a height.
<Stack spacing={5}><Progress colorScheme='green' size='sm' value={20} /><Progress colorScheme='green' size='md' value={20} /><Progress colorScheme='green' size='lg' value={20} /><Progress colorScheme='green' height='32px' value={20} /></Stack>
Progress color scheme#
You can add colorScheme prop to any progress bar to apply any color that
exists in the theme.
<Progress value={20} size='xs' colorScheme='pink' />
Animated Progress#
To show an animated progress, pass the isIndeterminate prop.
<Progress size='xs' isIndeterminate />
Accessibility#
Progresshas aroleset toprogressbarto denote that it is a progress.Progresshasaria-valuenowset to the percentage completion value passed to the component, to ensure the progress percent is visible to screen readers.
Props#
colorScheme
colorScheme"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram"bluehasStripe
hasStripeIf true, the progress bar will show stripe
booleanfalseisAnimated
isAnimatedIf true, and hasStripe is true, the stripes will be animated
booleanfalseisIndeterminate
isIndeterminateIf true, the progress will be indeterminate and the value
prop will be ignored
booleanfalsemax
maxThe maximum value of the progress
number100min
minThe minimum value of the progress
number0size
sizeThe size of the Progress
"xs" | "sm" | "md" | "lg"mdvalue
valueThe value of the progress indicator.
If undefined the progress bar will be in indeterminate state
numbervariant
variantThe variant of the Progress
string