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:

Circular Progress

Import

import CircularProgress from '@mui/joy/CircularProgress';
// or
import { CircularProgress } from '@mui/joy';

You can 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.

Name	Type	Default	Description
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'primary'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
determinate	bool	false	The boolean to select a variant. Use indeterminate when there is no progress value.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ progress?: func \| object, root?: func \| object, svg?: func \| object, track?: func \| object }	{}	The props used for each slot inside.
slots	{ progress?: elementType, root?: elementType, svg?: elementType, track?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
thickness	number		The thickness of the circle.
value	number	determinate ? 0 : 25	The value of the progress indicator for the determinate variant. Value between 0 and 100.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'soft'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

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.

Name	Default class	Default HTML tag	Description
root	.MuiCircularProgress-root	'span'	The component that renders the root.
svg	.MuiCircularProgress-svg	'svg'	The component that renders the svg.
track	.MuiCircularProgress-track	'circle'	The component that renders the track.
progress	.MuiCircularProgress-progress	'circle'	The component that renders the progress.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

CSS classes

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

Global class	Description
.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-colorInfo	Class name applied to the root element if `color="info"`.
.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"`.