CircularProgress API
The API documentation of the CircularProgress React component. Learn more about the properties and the CSS customization points.
import CircularProgress from '@material-ui/core/CircularProgress';ARIA
If the progress bar is describing the loading progress of a particular region of a page,
you should use aria-describedby to point to the progress bar, and set the aria-busy
attribute to true on that region until it has finished loading.
Props
| Name | Type | Default | Description |
|---|---|---|---|
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | enum: 'primary' | 'secondary' | 'inherit' |
'primary' | The color of the component. It supports those theme colors that make sense for this component. |
| disableShrink | bool | false | If true, the shrink animation is disabled. This only works if variant is indeterminate. |
| size | union: number | string |
40 | The size of the circle. |
| thickness | number | 3.6 | The thickness of the circle. |
| value | number | 0 | The value of the progress indicator for the determinate and static variants. Value between 0 and 100. |
| variant | enum: 'determinate' | 'indeterminate' | 'static' |
'indeterminate' | The variant to use. Use indeterminate when there is no progress value. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| static | Styles applied to the root element if variant="static". |
| indeterminate | Styles applied to the root element if variant="indeterminate". |
| colorPrimary | Styles applied to the root element if color="primary". |
| colorSecondary | Styles applied to the root element if color="secondary". |
| svg | Styles applied to the svg element. |
| circle | Styles applied to the circle svg path. |
| circleStatic | Styles applied to the circle svg path if variant="static". |
| circleIndeterminate | Styles applied to the circle svg path if variant="indeterminate". |
| circleDisableShrink | Styles applied to the circle svg path if disableShrink={true}. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiCircularProgress.
Notes
The component is fully StrictMode compatible.