{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string"
},
"default": "'primary'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"determinate": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'
| 'md'
| 'lg'
| string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ progress?: func
| object, root?: func
| object, svg?: func
| object, track?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ progress?: elementType, root?: elementType, svg?: elementType, track?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
},
"thickness": { "type": { "name": "number" } },
"value": { "type": { "name": "number" }, "default": "determinate ? 0 : 25" },
"variant": {
"type": {
"name": "union",
"description": "'outlined'
| 'plain'
| 'soft'
| 'solid'
| string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "CircularProgress",
"imports": [
"import CircularProgress from '@mui/joy/CircularProgress';",
"import { CircularProgress } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiCircularProgress-root"
},
{
"name": "svg",
"description": "The component that renders the svg.",
"default": "'svg'",
"class": "MuiCircularProgress-svg"
},
{
"name": "track",
"description": "The component that renders the track.",
"default": "'circle'",
"class": "MuiCircularProgress-track"
},
{
"name": "progress",
"description": "The component that renders the progress.",
"default": "'circle'",
"class": "MuiCircularProgress-progress"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiCircularProgress-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiCircularProgress-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiCircularProgress-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiCircularProgress-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiCircularProgress-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiCircularProgress-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "determinate",
"className": "MuiCircularProgress-determinate",
"description": "Class name applied to the root element if `determinate` is true.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiCircularProgress-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiCircularProgress-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiCircularProgress-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiCircularProgress-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiCircularProgress-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiCircularProgress-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiCircularProgress-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCircularProgress",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/CircularProgress/CircularProgress.tsx",
"inheritance": null,
"demos": "