{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"flex": { "type": { "name": "bool" }, "default": "false" },
"maxHeight": { "type": { "name": "union", "description": "number
| string" } },
"minHeight": { "type": { "name": "union", "description": "number
| string" } },
"objectFit": {
"type": {
"name": "enum",
"description": "'-moz-initial'
| 'contain'
| 'cover'
| 'fill'
| 'inherit'
| 'initial'
| 'none'
| 'revert-layer'
| 'revert'
| 'scale-down'
| 'unset'"
},
"default": "'cover'"
},
"ratio": {
"type": { "name": "union", "description": "number
| string" },
"default": "'16 / 9'"
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ content?: func
| object, root?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ content?: elementType, root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'
| 'plain'
| 'soft'
| 'solid'
| string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AspectRatio",
"imports": [
"import AspectRatio from '@mui/joy/AspectRatio';",
"import { AspectRatio } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAspectRatio-root"
},
{
"name": "content",
"description": "The component that renders the content.",
"default": "'div'",
"class": "MuiAspectRatio-content"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAspectRatio-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAspectRatio-colorDanger",
"description": "Class name applied to the content element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAspectRatio-colorNeutral",
"description": "Class name applied to the content element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAspectRatio-colorPrimary",
"description": "Class name applied to the content element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAspectRatio-colorSuccess",
"description": "Class name applied to the content element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAspectRatio-colorWarning",
"description": "Class name applied to the content element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAspectRatio-variantOutlined",
"description": "Class name applied to the content element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAspectRatio-variantPlain",
"description": "Class name applied to the content element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAspectRatio-variantSoft",
"description": "Class name applied to the content element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAspectRatio-variantSolid",
"description": "Class name applied to the content element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAspectRatio",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AspectRatio/AspectRatio.tsx",
"inheritance": null,
"demos": "