跳转到内容
编辑此页面

CircularProgress API

API documentation for the React CircularProgress component. Learn about the available props, and the CSS API.

Import

import CircularProgress from '@mui/material/CircularProgress';
// 或
import { CircularProgress } from '@mui/material';
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 MuiCircularProgress can be used when providing default props or style overrides in the theme.

属性

Props of the 原生（Native） component are also available.

名称类型默认值描述
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'inherit'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string		'primary'
The color of the component. It supports those theme colors that make sense for this component.
disableShrinkboolfalse
If true, the shrink animation is disabled. This only works if variant is indeterminate.
sizenumber
| string		40
The size of the circle. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'.
sxfunc
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
thicknessnumber3.6
The thickness of the circle.
valuenumber0
The value of the progress indicator for the determinate variant. Value between 0 and 100.
variant'determinate'
| 'indeterminate'		'indeterminate'
The variant to use. Use indeterminate when there is no progress value.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiCircularProgress-rootStyles applied to the root element.
determinate.MuiCircularProgress-determinateStyles applied to the root element if variant="determinate".
indeterminate.MuiCircularProgress-indeterminateStyles applied to the root element if variant="indeterminate".
colorPrimary.MuiCircularProgress-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiCircularProgress-colorSecondaryStyles applied to the root element if color="secondary".
svg.MuiCircularProgress-svgStyles applied to the svg element.
circle.MuiCircularProgress-circleStyles applied to the `circle` svg path.
circleDeterminate.MuiCircularProgress-circleDeterminateStyles applied to the `circle` svg path if variant="determinate".
circleIndeterminate.MuiCircularProgress-circleIndeterminateStyles applied to the `circle` svg path if variant="indeterminate".
circleDisableShrink.MuiCircularProgress-circleDisableShrinkStyles applied to the `circle` svg path if disableShrink={true}.

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

Demos