react-test/docs/pages/joy-ui/api/drawer.json

{
  "props": {
    "open": { "type": { "name": "bool" }, "required": true },
    "anchor": {
      "type": {
        "name": "enum",
        "description": "'bottom'<br>&#124;&nbsp;'left'<br>&#124;&nbsp;'right'<br>&#124;&nbsp;'top'"
      },
      "default": "'left'"
    },
    "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" } },
    "container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
    "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" },
    "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" },
    "disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" },
    "disablePortal": { "type": { "name": "bool" }, "default": "false" },
    "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" },
    "disableScrollLock": { "type": { "name": "bool" }, "default": "false" },
    "hideBackdrop": { "type": { "name": "bool" }, "default": "false" },
    "invertedColors": { "type": { "name": "bool" }, "default": "false" },
    "onClose": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(event: object, reason: string) => void",
        "describedArgs": ["event", "reason"]
      }
    },
    "size": {
      "type": { "name": "enum", "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'" },
      "default": "'md'",
      "additionalInfo": { "joy-size": true }
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ backdrop?: func<br>&#124;&nbsp;object, content?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ backdrop?: elementType, content?: elementType, root?: elementType }"
      },
      "default": "{}",
      "additionalInfo": { "slotsApi": true }
    },
    "variant": {
      "type": {
        "name": "enum",
        "description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
      },
      "default": "'plain'",
      "additionalInfo": { "joy-variant": true }
    }
  },
  "name": "Drawer",
  "imports": ["import Drawer from '@mui/joy/Drawer';", "import { Drawer } from '@mui/joy';"],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root.",
      "default": "'div'",
      "class": "MuiDrawer-root"
    },
    {
      "name": "backdrop",
      "description": "The component that renders the backdrop.",
      "default": "'div'",
      "class": "MuiDrawer-backdrop"
    },
    {
      "name": "content",
      "description": "The component that renders the content of the drawer.",
      "default": "'div'",
      "class": "MuiDrawer-content"
    }
  ],
  "classes": [
    {
      "key": "colorContext",
      "className": "MuiDrawer-colorContext",
      "description": "Class name applied to the root element when color inversion is triggered.",
      "isGlobal": false
    },
    {
      "key": "colorDanger",
      "className": "MuiDrawer-colorDanger",
      "description": "Class name applied to the root element if `color=\"danger\"`.",
      "isGlobal": false
    },
    {
      "key": "colorNeutral",
      "className": "MuiDrawer-colorNeutral",
      "description": "Class name applied to the root element if `color=\"neutral\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiDrawer-colorPrimary",
      "description": "Class name applied to the root element if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiDrawer-colorSuccess",
      "description": "Class name applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiDrawer-colorWarning",
      "description": "Class name applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "hidden",
      "className": "MuiDrawer-hidden",
      "description": "Class name applied to the root element when open is false.",
      "isGlobal": false
    },
    {
      "key": "sizeLg",
      "className": "MuiDrawer-sizeLg",
      "description": "Class name applied to the root element if `size=\"lg\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeMd",
      "className": "MuiDrawer-sizeMd",
      "description": "Class name applied to the root element if `size=\"md\"`.",
      "isGlobal": false
    },
    {
      "key": "sizeSm",
      "className": "MuiDrawer-sizeSm",
      "description": "Class name applied to the root element if `size=\"sm\"`.",
      "isGlobal": false
    },
    {
      "key": "variantOutlined",
      "className": "MuiDrawer-variantOutlined",
      "description": "Class name applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "variantPlain",
      "className": "MuiDrawer-variantPlain",
      "description": "Class name applied to the root element if `variant=\"plain\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSoft",
      "className": "MuiDrawer-variantSoft",
      "description": "Class name applied to the root element if `variant=\"soft\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSolid",
      "className": "MuiDrawer-variantSolid",
      "description": "Class name applied to the root element if `variant=\"solid\"`.",
      "isGlobal": false
    }
  ],
  "spread": true,
  "themeDefaultProps": false,
  "muiName": "JoyDrawer",
  "forwardsRefTo": "HTMLDivElement",
  "filename": "/packages/mui-joy/src/Drawer/Drawer.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/joy-ui/react-drawer/\">Drawer</a></li></ul>",
  "cssComponent": false
}