Circular Progress
Circular Progress is used to indicates the progress for determinate and indeterminate processes.
Import
import { CircularProgress, CircularProgressLabel } from '@chakra-ui/react';
Usage
There are two types of progress indicators: determinate and indeterminate.
- Determinate progress: fills the circular track with color, as the indicator moves from 0 to 360 degrees.
- Indeterminate progress: grows and shrinks the indicator while moving along the circular track.
Changing the size
You can add size
prop to the progress bar to add a custom size.
Changing the thickness
You can add the thickness
prop to update the thickness of the progress ring.
This defines the stroke width of the svg circle.
Changing the color
You can add color
prop to any progress bar to apply any color that exists in
the theme.
Adding label
Chakra exports a CircularProgressLabel
to help you add a label. Pass this
component as children
prop and you'll be able to render the value.
Indeterminate Progress
Setting the progress to indeterminate means you're not able to determine the
value
upfront. Pass the isIndeterminate
prop to activate this state.
Accessibility
- Progress has
role
set toprogressbar
to denote that it is a progress bar. - Progress has
aria-valuenow
set to the percentage completion value passed to the component, to ensure the progress percent is visible to screen readers.
Props
capIsRound
capIsRound
If true
, the cap of the progress indicator will be rounded.
boolean
getValueText
getValueText
A function that returns the desired valueText to use in place of the value
((value: number, percent: number) => string)
isIndeterminate
isIndeterminate
If true
, the progress will be indeterminate and the value
prop will be ignored
boolean
max
max
Maximum value defining 100% progress made (must be higher than 'min')
number
100
min
min
Minimum value defining 'no progress' (must be lower than 'max')
number
0
size
size
Sizes for CircularProgress
are not implemented in the default theme. You can extend the theme to implement them.
string
thickness
thickness
This defines the stroke width of the svg circle.
string | number
"10px"
trackColor
trackColor
The color name of the progress track. Use a color key in the theme object
string
value
value
Current progress (must be between min/max)
number
valueText
valueText
The desired valueText to use in place of the value
string