Skip to content
Edit this page

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

The color of the component. It supports those theme colors that make sense for this component.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'primary'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
determinate

The boolean to select a variant. Use indeterminate when there is no progress value.

Type:

bool

Default:

false
size

The size of the component. It accepts theme values between 'sm' and 'lg'.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ progress?: func | object, root?: func | object, svg?: func | object, track?: func | object }

Default:

{}
slots

The components used for each slot inside.

Type:

{ progress?: elementType, root?: elementType, svg?: elementType, track?: elementType }

Default:

{}
sx

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

Type:

Array<func | object | bool> | func | object
thickness

The thickness of the circle.

Type:

number
value

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

Type:

number

Default:

determinate ? 0 : 25
variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'soft'
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'span'Required

Global class: .MuiCircularProgress-root

Description: The component that renders the root.

svg'svg'Required

Global class: .MuiCircularProgress-svg

Description: The component that renders the svg.

track'circle'Required

Global class: .MuiCircularProgress-track

Description: The component that renders the track.

progress'circle'Required

Global class: .MuiCircularProgress-progress

Description: The component that renders the progress.

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

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

Class name applied to the root element when color inversion is triggered.

.MuiCircularProgress-colorDanger

Class name applied to the root element if color="danger".

.MuiCircularProgress-colorNeutral

Class name applied to the root element if color="neutral".

.MuiCircularProgress-colorPrimary

Class name applied to the root element if color="primary".

.MuiCircularProgress-colorSuccess

Class name applied to the root element if color="success".

.MuiCircularProgress-colorWarning

Class name applied to the root element if color="warning".

.MuiCircularProgress-determinate

Class name applied to the root element if determinate is true.

.MuiCircularProgress-sizeLg

Class name applied to the root element if size="lg".

.MuiCircularProgress-sizeMd

Class name applied to the root element if size="md".

.MuiCircularProgress-sizeSm

Class name applied to the root element if size="sm".

.MuiCircularProgress-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiCircularProgress-variantPlain

Class name applied to the root element if variant="plain".

.MuiCircularProgress-variantSoft

Class name applied to the root element if variant="soft".

.MuiCircularProgress-variantSolid

Class name applied to the root element if variant="solid".