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.

Component name

The name JoyCircularProgress can be used when providing default props or style overrides in the theme.

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.
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'.
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 variant to use.

The ref is forwarded to the root element.