react-test/docs/pages/material-ui/api/avatar-group.json

{
  "props": {
    "children": { "type": { "name": "node" } },
    "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
    "component": { "type": { "name": "elementType" } },
    "componentsProps": {
      "type": { "name": "shape", "description": "{ additionalAvatar?: object }" },
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps</code> prop instead. This prop will be removed in a future major release. See <a href=\"https://mui.com/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "max": { "type": { "name": "custom", "description": "number" }, "default": "5" },
    "renderSurplus": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(surplus: number) => React.ReactNode",
        "describedArgs": ["surplus"],
        "returned": "React.ReactNode"
      }
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ additionalAvatar?: object, surplus?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": { "name": "shape", "description": "{ surplus?: elementType }" },
      "default": "{}"
    },
    "spacing": {
      "type": {
        "name": "union",
        "description": "'medium'<br>&#124;&nbsp;'small'<br>&#124;&nbsp;number"
      },
      "default": "'medium'"
    },
    "sx": {
      "type": {
        "name": "union",
        "description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
      },
      "additionalInfo": { "sx": true }
    },
    "total": { "type": { "name": "number" }, "default": "children.length" },
    "variant": {
      "type": {
        "name": "union",
        "description": "'circular'<br>&#124;&nbsp;'rounded'<br>&#124;&nbsp;'square'<br>&#124;&nbsp;string"
      },
      "default": "'circular'"
    }
  },
  "name": "AvatarGroup",
  "imports": [
    "import AvatarGroup from '@mui/material/AvatarGroup';",
    "import { AvatarGroup } from '@mui/material';"
  ],
  "slots": [{ "name": "surplus", "description": "", "class": null }],
  "classes": [
    {
      "key": "avatar",
      "className": "MuiAvatarGroup-avatar",
      "description": "Styles applied to the avatar elements.",
      "isGlobal": false
    },
    {
      "key": "root",
      "className": "MuiAvatarGroup-root",
      "description": "Styles applied to the root element.",
      "isGlobal": false
    }
  ],
  "spread": true,
  "themeDefaultProps": true,
  "muiName": "MuiAvatarGroup",
  "filename": "/packages/mui-material/src/AvatarGroup/AvatarGroup.js",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/material-ui/react-avatar/\">Avatar</a></li></ul>",
  "cssComponent": false
}