40 lines
1.7 KiB
JSON
40 lines
1.7 KiB
JSON
|
|
{
|
||
|
|
"componentDescription": "",
|
||
|
|
"propDescriptions": {
|
||
|
|
"children": { "description": "The avatars to stack." },
|
||
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
||
|
|
"component": {
|
||
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
||
|
|
},
|
||
|
|
"componentsProps": {
|
||
|
|
"description": "The extra props for the slot components. You can override the existing props or add new ones.<br>This prop is an alias for the <code>slotProps</code> prop."
|
||
|
|
},
|
||
|
|
"max": { "description": "Max avatars to show before +x." },
|
||
|
|
"renderSurplus": {
|
||
|
|
"description": "custom renderer of extraAvatars",
|
||
|
|
"typeDescriptions": {
|
||
|
|
"surplus": { "name": "surplus", "description": "number of extra avatars" },
|
||
|
|
"React.ReactNode": { "name": "React.ReactNode", "description": "custom element to display" }
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
||
|
|
"slots": { "description": "The components used for each slot inside." },
|
||
|
|
"spacing": { "description": "Spacing between avatars." },
|
||
|
|
"sx": {
|
||
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
||
|
|
},
|
||
|
|
"total": {
|
||
|
|
"description": "The total number of avatars. Used for calculating the number of extra avatars."
|
||
|
|
},
|
||
|
|
"variant": { "description": "The variant to use." }
|
||
|
|
},
|
||
|
|
"classDescriptions": {
|
||
|
|
"avatar": {
|
||
|
|
"description": "Styles applied to {{nodeName}}.",
|
||
|
|
"nodeName": "the avatar elements"
|
||
|
|
},
|
||
|
|
"root": { "description": "Styles applied to the root element." }
|
||
|
|
},
|
||
|
|
"slotDescriptions": { "surplus": "" }
|
||
|
|
}
|