005cf56baf
Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
79 lines
4.6 KiB
JSON
79 lines
4.6 KiB
JSON
{
|
|
"componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.",
|
|
"propDescriptions": {
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"color": {
|
|
"description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the <a href=\"https://mui.com/material-ui/customization/palette/#custom-colors\">palette customization guide</a>."
|
|
},
|
|
"disableShrink": {
|
|
"description": "If <code>true</code>, the shrink animation is disabled. This only works if variant is <code>indeterminate</code>."
|
|
},
|
|
"enableTrackSlot": {
|
|
"description": "If <code>true</code>, a track circle slot is mounted to show a subtle background for the progress. The <code>size</code> and <code>thickness</code> apply to the track slot to be consistent with the progress circle."
|
|
},
|
|
"size": {
|
|
"description": "The size of the component. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, for example '3rem'."
|
|
},
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"thickness": { "description": "The thickness of the circle." },
|
|
"value": {
|
|
"description": "The value of the progress indicator for the determinate variant. Value between 0 and 100."
|
|
},
|
|
"variant": {
|
|
"description": "The variant to use. Use indeterminate when there is no progress value."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"circle": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the <code>circle</code> svg path"
|
|
},
|
|
"circleDeterminate": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the <code>circle</code> svg path",
|
|
"conditions": "<code>variant=\"determinate\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/circular-progress/#circular-progress-classes-MuiCircularProgress-circle\">.MuiCircularProgress-circle</a> and <a href=\"/material-ui/api/circular-progress/#circular-progress-classes-MuiCircularProgress-determinate\">.MuiCircularProgress-determinate</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"circleDisableShrink": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the <code>circle</code> svg path",
|
|
"conditions": "<code>disableShrink={true}</code>"
|
|
},
|
|
"circleIndeterminate": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the <code>circle</code> svg path",
|
|
"conditions": "<code>variant=\"indeterminate\"</code>",
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/circular-progress/#circular-progress-classes-MuiCircularProgress-circle\">.MuiCircularProgress-circle</a> and <a href=\"/material-ui/api/circular-progress/#circular-progress-classes-MuiCircularProgress-indeterminate\">.MuiCircularProgress-indeterminate</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
|
|
},
|
|
"colorPrimary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"primary\"</code>"
|
|
},
|
|
"colorSecondary": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>color=\"secondary\"</code>"
|
|
},
|
|
"determinate": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"determinate\"</code>"
|
|
},
|
|
"indeterminate": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>variant=\"indeterminate\"</code>"
|
|
},
|
|
"root": { "description": "Styles applied to the root element." },
|
|
"svg": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the svg element" },
|
|
"track": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the track slot",
|
|
"conditions": "<code>enableTrackSlot={true}</code>"
|
|
}
|
|
}
|
|
}
|