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.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import CircularProgress from '@mui/joy/CircularProgress';
// or
import { CircularProgress } from '@mui/joy';
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.

color

component

determinate

size

slotProps

slots

sx

thickness

value

variant

The ref is forwarded to the root element.

Theme default props

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


Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root

svg

track

progress

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiCircularProgress-colorContext

.MuiCircularProgress-colorDanger

.MuiCircularProgress-colorNeutral

.MuiCircularProgress-colorPrimary

.MuiCircularProgress-colorSuccess

.MuiCircularProgress-colorWarning

.MuiCircularProgress-determinate

.MuiCircularProgress-sizeLg

.MuiCircularProgress-sizeMd

.MuiCircularProgress-sizeSm

.MuiCircularProgress-variantOutlined

.MuiCircularProgress-variantPlain

.MuiCircularProgress-variantSoft

.MuiCircularProgress-variantSolid