react-test/docs/pages/joy-ui/api/aspect-ratio.json

{
  "props": {
    "children": { "type": { "name": "node" } },
    "color": {
      "type": {
        "name": "enum",
        "description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
      },
      "default": "'neutral'",
      "additionalInfo": { "joy-color": true }
    },
    "component": { "type": { "name": "elementType" } },
    "flex": { "type": { "name": "bool" }, "default": "false" },
    "maxHeight": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
    "minHeight": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
    "objectFit": {
      "type": {
        "name": "enum",
        "description": "'-moz-initial'<br>&#124;&nbsp;'contain'<br>&#124;&nbsp;'cover'<br>&#124;&nbsp;'fill'<br>&#124;&nbsp;'inherit'<br>&#124;&nbsp;'initial'<br>&#124;&nbsp;'none'<br>&#124;&nbsp;'revert-layer'<br>&#124;&nbsp;'revert'<br>&#124;&nbsp;'scale-down'<br>&#124;&nbsp;'unset'"
      },
      "default": "'cover'"
    },
    "ratio": {
      "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" },
      "default": "'16 / 9'"
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ content?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": { "name": "shape", "description": "{ content?: elementType, root?: elementType }" },
      "default": "{}",
      "additionalInfo": { "slotsApi": true }
    },
    "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 }
    },
    "variant": {
      "type": {
        "name": "union",
        "description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;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": "<ul><li><a href=\"/joy-ui/react-aspect-ratio/\">Aspect Ratio</a></li>\n<li><a href=\"/joy-ui/react-skeleton/\">Skeleton</a></li></ul>",
  "cssComponent": false
}