react-test/docs/pages/material-ui/api/swipeable-drawer.json

{
  "props": {
    "onClose": {
      "type": { "name": "func" },
      "required": true,
      "signature": {
        "type": "function(event: React.SyntheticEvent<{}>) => void",
        "describedArgs": ["event"]
      }
    },
    "onOpen": {
      "type": { "name": "func" },
      "required": true,
      "signature": {
        "type": "function(event: React.SyntheticEvent<{}>) => void",
        "describedArgs": ["event"]
      }
    },
    "allowSwipeInChildren": {
      "type": { "name": "union", "description": "func<br>&#124;&nbsp;bool" },
      "default": "false"
    },
    "children": { "type": { "name": "node" } },
    "disableBackdropTransition": { "type": { "name": "bool" }, "default": "false" },
    "disableDiscovery": { "type": { "name": "bool" }, "default": "false" },
    "disableSwipeToOpen": {
      "type": { "name": "bool" },
      "default": "typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)"
    },
    "hysteresis": { "type": { "name": "number" }, "default": "0.52" },
    "minFlingVelocity": { "type": { "name": "number" }, "default": "450" },
    "open": { "type": { "name": "bool" }, "default": "false" },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ backdrop?: func<br>&#124;&nbsp;object, docked?: func<br>&#124;&nbsp;object, paper?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, swipeArea?: func<br>&#124;&nbsp;object, transition?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ backdrop?: elementType, docked?: elementType, paper?: elementType, root?: elementType, swipeArea?: elementType, transition?: elementType }"
      },
      "default": "{}"
    },
    "SwipeAreaProps": {
      "type": { "name": "object" },
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps.swipeArea</code> prop instead. This prop will be removed in a future major release. See <a href=\"https://mui.com/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "swipeAreaWidth": { "type": { "name": "number" }, "default": "20" },
    "transitionDuration": {
      "type": {
        "name": "union",
        "description": "number<br>&#124;&nbsp;{ appear?: number, enter?: number, exit?: number }"
      },
      "default": "{\n  enter: theme.transitions.duration.enteringScreen,\n  exit: theme.transitions.duration.leavingScreen,\n}"
    }
  },
  "name": "SwipeableDrawer",
  "imports": [
    "import SwipeableDrawer from '@mui/material/SwipeableDrawer';",
    "import { SwipeableDrawer } from '@mui/material';"
  ],
  "slots": [
    {
      "name": "swipeArea",
      "description": "The component used for the swipeArea slot.",
      "default": "div",
      "class": null
    }
  ],
  "classes": [
    {
      "key": "anchorBottom",
      "className": "MuiDrawer-anchorBottom",
      "description": "Styles applied to the root element if `anchor=\"bottom\"`.",
      "isGlobal": false
    },
    {
      "key": "anchorLeft",
      "className": "MuiDrawer-anchorLeft",
      "description": "Styles applied to the root element if `anchor=\"left\"`.",
      "isGlobal": false
    },
    {
      "key": "anchorRight",
      "className": "MuiDrawer-anchorRight",
      "description": "Styles applied to the root element if `anchor=\"right\"`.",
      "isGlobal": false
    },
    {
      "key": "anchorTop",
      "className": "MuiDrawer-anchorTop",
      "description": "Styles applied to the root element if `anchor=\"top\"`.",
      "isGlobal": false
    },
    {
      "key": "docked",
      "className": "MuiDrawer-docked",
      "description": "Styles applied to the root element if `variant=\"permanent or persistent\"`.",
      "isGlobal": false
    },
    {
      "key": "modal",
      "className": "MuiDrawer-modal",
      "description": "Styles applied to the Modal component.",
      "isGlobal": false
    },
    {
      "key": "paper",
      "className": "MuiDrawer-paper",
      "description": "Styles applied to the Paper component.",
      "isGlobal": false
    },
    {
      "key": "paperAnchorBottom",
      "className": "MuiDrawer-paperAnchorBottom",
      "description": "Styles applied to the Paper component if `anchor=\"bottom\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorDockedBottom",
      "className": "MuiDrawer-paperAnchorDockedBottom",
      "description": "Styles applied to the Paper component if `anchor=\"bottom\"` and `variant` is not \"temporary\".",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorDockedLeft",
      "className": "MuiDrawer-paperAnchorDockedLeft",
      "description": "Styles applied to the Paper component if `anchor=\"left\"` and `variant` is not \"temporary\".",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorDockedRight",
      "className": "MuiDrawer-paperAnchorDockedRight",
      "description": "Styles applied to the Paper component if `anchor=\"right\"` and `variant` is not \"temporary\".",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorDockedTop",
      "className": "MuiDrawer-paperAnchorDockedTop",
      "description": "Styles applied to the Paper component if `anchor=\"top\"` and `variant` is not \"temporary\".",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorLeft",
      "className": "MuiDrawer-paperAnchorLeft",
      "description": "Styles applied to the Paper component if `anchor=\"left\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorRight",
      "className": "MuiDrawer-paperAnchorRight",
      "description": "Styles applied to the Paper component if `anchor=\"right\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "paperAnchorTop",
      "className": "MuiDrawer-paperAnchorTop",
      "description": "Styles applied to the Paper component if `anchor=\"top\"`.",
      "isGlobal": false,
      "isDeprecated": true
    },
    {
      "key": "root",
      "className": "MuiDrawer-root",
      "description": "Styles applied to the root element.",
      "isGlobal": false
    }
  ],
  "spread": true,
  "themeDefaultProps": false,
  "muiName": "MuiSwipeableDrawer",
  "forwardsRefTo": "HTMLDivElement",
  "filename": "/packages/mui-material/src/SwipeableDrawer/SwipeableDrawer.js",
  "inheritance": { "component": "Drawer", "pathname": "/material-ui/api/drawer/" },
  "demos": "<ul><li><a href=\"/material-ui/react-drawer/\">Drawer</a></li></ul>",
  "cssComponent": false
}