圆形进度条API
React CircularProgress 组件的 API 参考文档。了解此导出模块的属性、CSS 和其他 API。
演示
导入
import CircularProgress from '@mui/material/CircularProgress';
// or
import { CircularProgress } from '@mui/material';
通过阅读这篇关于最小化 bundle 大小的指南,了解两者之间的区别。
ARIA
如果进度条描述的是页面特定区域的加载进度,您应该使用 aria-describedby
指向进度条,并将该区域的 aria-busy
属性设置为 true
,直到加载完成。
原生组件的属性也可用。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
classes | object | - | 覆盖或扩展应用于组件的样式。 有关更多详细信息,请参阅下面的 CSS 类 API。 |
color | 'inherit' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' | 组件的颜色。它支持默认主题颜色和自定义主题颜色,可以按照调色板自定义指南中所示的方式添加。 |
disableShrink | bool | false | 如果为 |
size | number | string | 40 | 组件的大小。如果使用数字,则假定单位为像素。如果使用字符串,则需要提供 CSS 单位,例如 '3rem'。 |
sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统属性。 有关更多详细信息,请参阅 `sx` 页面。 |
thickness | number | 3.6 | 圆的粗细。 |
value | number | 0 | 确定型 variant 的进度指示器的值。值介于 0 到 100 之间。 |
variant | 'determinate' | 'indeterminate' | 'indeterminate' | 要使用的 variant。当没有进度值时,请使用 indeterminate。 |
ref
被转发到根元素。主题默认属性
您可以使用 MuiCircularProgress
通过主题更改此组件的默认属性。
这些类名对于使用 CSS 进行样式设置很有用。当特定状态被触发时,它们会被应用于组件的插槽。
类名 | 规则名称 | 描述 |
---|---|---|
.MuiCircularProgress-circle | circle | 应用于 circle svg 路径的样式。 |
.MuiCircularProgress-circleDeterminate | circleDeterminate | 如果 variant="determinate" ,则应用于 circle svg 路径的样式。 |
.MuiCircularProgress-circleDisableShrink | circleDisableShrink | 如果 disableShrink={true} ,则应用于 circle svg 路径的样式。 |
.MuiCircularProgress-circleIndeterminate | circleIndeterminate | 如果 variant="indeterminate" ,则应用于 circle svg 路径的样式。 |
.MuiCircularProgress-colorPrimary | colorPrimary | 如果 color="primary" ,则应用于根元素的样式。 |
.MuiCircularProgress-colorSecondary | colorSecondary | 如果 color="secondary" ,则应用于根元素的样式。 |
.MuiCircularProgress-determinate | determinate | 如果 variant="determinate" ,则应用于根元素的样式。 |
.MuiCircularProgress-indeterminate | indeterminate | 如果 variant="indeterminate" ,则应用于根元素的样式。 |
.MuiCircularProgress-root | root | 应用于根元素的样式。 |
.MuiCircularProgress-svg | svg | 应用于 svg 元素的样式。 |
您可以使用以下自定义选项之一覆盖组件的样式
- 使用全局类名。
- 在自定义主题中,使用作为组件的
styleOverrides
属性一部分的规则名称。
源代码
如果您在此页面中没有找到所需信息,请考虑查看组件的实现以获取更多详细信息。