Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
92 lines
3.9 KiB
JSON
92 lines
3.9 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"children": {
|
|
"description": "Used to render icon or text elements inside the AspectRatio if <code>src</code> is not set. This can be an element, or just a string."
|
|
},
|
|
"color": {
|
|
"description": "The color of the component. It supports those theme colors that make sense for this component."
|
|
},
|
|
"component": {
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
|
},
|
|
"flex": {
|
|
"description": "By default, the AspectRatio will maintain the aspect ratio of its content. Set this prop to <code>true</code> when the container is a flex row and you want the AspectRatio to fill the height of its container."
|
|
},
|
|
"maxHeight": {
|
|
"description": "The maximum calculated height of the element (not the CSS height)."
|
|
},
|
|
"minHeight": {
|
|
"description": "The minimum calculated height of the element (not the CSS height)."
|
|
},
|
|
"objectFit": { "description": "The CSS object-fit value of the first-child." },
|
|
"ratio": {
|
|
"description": "The aspect-ratio of the element. The current implementation uses padding instead of the CSS aspect-ratio due to browser support. <a href=\"https://caniuse.com/?search=aspect-ratio\">https://caniuse.com/?search=aspect-ratio</a>"
|
|
},
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
|
"slots": { "description": "The components used for each slot inside." },
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"variant": {
|
|
"description": "The <a href=\"https://mui.com/joy-ui/main-features/global-variants/\">global variant</a> to use."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"colorContext": {
|
|
"description": "Class name applied to {{nodeName}} when {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "color inversion is triggered"
|
|
},
|
|
"colorDanger": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>color=\"danger\"</code>"
|
|
},
|
|
"colorNeutral": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>color=\"neutral\"</code>"
|
|
},
|
|
"colorPrimary": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>color=\"primary\"</code>"
|
|
},
|
|
"colorSuccess": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>color=\"success\"</code>"
|
|
},
|
|
"colorWarning": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>color=\"warning\"</code>"
|
|
},
|
|
"variantOutlined": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>variant=\"outlined\"</code>"
|
|
},
|
|
"variantPlain": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>variant=\"plain\"</code>"
|
|
},
|
|
"variantSoft": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>variant=\"soft\"</code>"
|
|
},
|
|
"variantSolid": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the content element",
|
|
"conditions": "<code>variant=\"solid\"</code>"
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"content": "The component that renders the content.",
|
|
"root": "The component that renders the root."
|
|
}
|
|
}
|