59 lines
2.6 KiB
JSON
59 lines
2.6 KiB
JSON
|
{
|
||
|
|
"componentDescription": "",
|
||
|
|
"propDescriptions": {
|
||
|
|
"alt": {
|
||
|
|
"description": "Used in combination with <code>src</code> or <code>srcSet</code> to provide an alt attribute for the rendered <code>img</code> element."
|
||
|
|
},
|
||
|
|
"children": {
|
||
|
|
"description": "Used to render icon or text elements inside the Avatar if <code>src</code> is not set. This can be an element, or just a string."
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
"imgProps": {
|
||
|
|
"description": "<a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/img#attributes\">Attributes</a> applied to the <code>img</code> element if the component is used to display an image. It can be used to listen for the loading error event."
|
||
|
|
},
|
||
|
|
"sizes": {
|
||
|
|
"description": "The <code>sizes</code> attribute for the <code>img</code> element."
|
||
|
|
},
|
||
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
||
|
|
"slots": { "description": "The components used for each slot inside." },
|
||
|
|
"src": { "description": "The <code>src</code> attribute for the <code>img</code> element." },
|
||
|
|
"srcSet": {
|
||
|
|
"description": "The <code>srcSet</code> attribute for the <code>img</code> element. Use this attribute for responsive image display."
|
||
|
|
},
|
||
|
|
"sx": {
|
||
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
||
|
|
},
|
||
|
|
"variant": { "description": "The shape of the avatar." }
|
||
|
|
},
|
||
|
|
"classDescriptions": {
|
||
|
|
"circular": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"circular\"</code>"
|
||
|
|
},
|
||
|
|
"colorDefault": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "not <code>src</code> or <code>srcSet</code>"
|
||
|
|
},
|
||
|
|
"rounded": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"rounded\"</code>"
|
||
|
|
},
|
||
|
|
"square": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"square\"</code>"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"slotDescriptions": {
|
||
|
|
"fallback": "The component that renders the fallback slot.",
|
||
|
|
"img": "The component that renders the img slot.",
|
||
|
|
"root": "The component that renders the root slot."
|
||
|
|
}
|
||
|
|
}
|