docs/translations/api-docs/circular-progress/circular-progress.json - master - githubmirror/material-ui

docs/translations/api-docs/circular-progress/circular-progress.json
72 строки3 KB
Silviu Alexandru Avram
[circularprogress][linearprogress] Improve accessibility (#48172)
15 апр 2026, 13:29
15 апр 2026, 13:29529b113
{
  "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."
    },
    "max": {
      "description": "The maximum value for the progress indicator for the determinate variant."
    },
    "min": {
      "description": "The minimum value for the progress indicator for the determinate variant."
    },
    "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 &#39;3rem&#39;."
    },
    "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 <code>min</code> and <code>max</code>."
    },
    "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"
    },
    "circleDisableShrink": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the <code>circle</code> svg path",
      "conditions": "<code>disableShrink={true}</code>"
    },
    "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>"
    }
  }
}