Skip to content

CircularProgress API

API reference docs for the React CircularProgress component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

Import

import CircularProgress from '@mui/material/CircularProgress';
// or
import { CircularProgress } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

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

Props of the native component are also available.

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Type:'inherit'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string

Default:'primary'

disableShrink

If true, the shrink animation is disabled. This only works if variant is indeterminate.

Type:bool

Default:false

size

The size of the component. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g. '3rem'.

Type:number
| string

Default:40

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

thickness

The thickness of the circle.

Type:number

Default:3.6

value

The value of the progress indicator for the determinate variant. Value between 0 and 100.

Type:number

Default:0

variant

The variant to use. Use indeterminate when there is no progress value.

Type:'determinate'
| 'indeterminate'

Default:'indeterminate'

The ref is forwarded to the root element.

Theme default props

You can use MuiCircularProgress to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiCircularProgress-circle

Styles applied to the circle svg path.

Rule name:circle

.MuiCircularProgress-circleDeterminate

Styles applied to the circle svg path if variant="determinate".

Rule name:circleDeterminate

.MuiCircularProgress-circleDisableShrink

Styles applied to the circle svg path if disableShrink={true}.

Rule name:circleDisableShrink

.MuiCircularProgress-circleIndeterminate

Styles applied to the circle svg path if variant="indeterminate".

Rule name:circleIndeterminate

.MuiCircularProgress-colorPrimary

Styles applied to the root element if color="primary".

Rule name:colorPrimary

.MuiCircularProgress-colorSecondary

Styles applied to the root element if color="secondary".

Rule name:colorSecondary

.MuiCircularProgress-determinate

Styles applied to the root element if variant="determinate".

Rule name:determinate

.MuiCircularProgress-indeterminate

Styles applied to the root element if variant="indeterminate".

Rule name:indeterminate

.MuiCircularProgress-root

Styles applied to the root element.

Rule name:root

.MuiCircularProgress-svg

Styles applied to the svg element.

Rule name:svg


You can override the style of the component using one of these customization options: