Circular Progress
The CircularProgress component is used to indicate the progress for determinate and indeterminate processes.
- 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.
Import#
import { CircularProgress, CircularProgressLabel } from "@chakra-ui/react"
Usage#
Editable Example
Changing the size#
You can add size
prop to the progress bar to add a custom size.
Editable Example
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.
Editable Example
Changing the color#
You can add color
prop to any progress bar to apply any color that exists in
the theme.
Editable Example
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.
40%
Editable Example
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.
Editable Example
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#
Name | Type | Description | Default |
---|---|---|---|
capIsRound | boolean | If `true`, the cap of the progress indicator will be rounded. | - |
getValueText | ((value: number, percent: number) => string) | A function that returns the desired valueText to use in place of the value | - |
isIndeterminate | boolean | If `true`, the progress will be indeterminate and the `value` prop will be ignored | - |
max | number | Maximum value defining 100% progress made (must be higher than 'min') | - |
min | number | Minimum value defining 'no progress' (must be lower than 'max') | - |
size | string | number | The size of the circular progress in CSS units | - |
thickness | string | number | This defines the stroke width of the svg circle. | - |
trackColor | string | The color name of the progress track. Use a color key in the theme object | - |
value | number | Current progress (must be between min/max) | - |
valueText | string | The desired valueText to use in place of the value | - |