react-test/docs/translations/api-docs/swipeable-drawer/swipeable-drawer.json

{
  "componentDescription": "",
  "propDescriptions": {
    "allowSwipeInChildren": {
      "description": "If set to true, the swipe event will open the drawer even if the user begins the swipe on one of the drawer's children. This can be useful in scenarios where the drawer is partially visible. You can customize it further with a callback that determines which children the user can drag over to open the drawer (for example, to ignore other elements that handle touch move events, like sliders)."
    },
    "children": { "description": "The content of the component." },
    "disableBackdropTransition": {
      "description": "Disable the backdrop transition. This can improve the FPS on low-end devices."
    },
    "disableDiscovery": {
      "description": "If <code>true</code>, touching the screen near the edge of the drawer will not slide in the drawer a bit to promote accidental discovery of the swipe gesture."
    },
    "disableSwipeToOpen": {
      "description": "If <code>true</code>, swipe to open is disabled. This is useful in browsers where swiping triggers navigation actions. Swipe to open is disabled on iOS browsers by default."
    },
    "hysteresis": {
      "description": "Affects how far the drawer must be opened/closed to change its state. Specified as percent (0-1) of the width of the drawer"
    },
    "minFlingVelocity": {
      "description": "Defines, from which (average) velocity on, the swipe is defined as complete although hysteresis isn&#39;t reached. Good threshold is between 250 - 1000 px/s"
    },
    "onClose": {
      "description": "Callback fired when the component requests to be closed.",
      "typeDescriptions": {
        "event": { "name": "event", "description": "The event source of the callback." }
      }
    },
    "onOpen": {
      "description": "Callback fired when the component requests to be opened.",
      "typeDescriptions": {
        "event": { "name": "event", "description": "The event source of the callback." }
      }
    },
    "open": { "description": "If <code>true</code>, the component is shown." },
    "slotProps": { "description": "The props used for each slot inside." },
    "slots": { "description": "The components used for each slot inside." },
    "SwipeAreaProps": {
      "description": "The element is used to intercept the touch events on the edge."
    },
    "swipeAreaWidth": {
      "description": "The width of the left most (or right most) area in <code>px</code> that the drawer can be swiped open from."
    },
    "transitionDuration": {
      "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object."
    }
  },
  "classDescriptions": {
    "anchorBottom": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchor=\"bottom\"</code>"
    },
    "anchorLeft": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchor=\"left\"</code>"
    },
    "anchorRight": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchor=\"right\"</code>"
    },
    "anchorTop": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchor=\"top\"</code>"
    },
    "docked": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>variant=\"permanent or persistent\"</code>"
    },
    "modal": {
      "description": "Styles applied to {{nodeName}}.",
      "nodeName": "the Modal component"
    },
    "paper": {
      "description": "Styles applied to {{nodeName}}.",
      "nodeName": "the Paper component"
    },
    "paperAnchorBottom": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"bottom\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorBottom\">.MuiDrawer-anchorBottom</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorDockedBottom": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"bottom\"</code> and <code>variant</code> is not &quot;temporary&quot;",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorBottom\">.MuiDrawer-anchorBottom</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorDockedLeft": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"left\"</code> and <code>variant</code> is not &quot;temporary&quot;",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorLeft\">.MuiDrawer-anchorLeft</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorDockedRight": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"right\"</code> and <code>variant</code> is not &quot;temporary&quot;",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorRight\">.MuiDrawer-anchorRight</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorDockedTop": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"top\"</code> and <code>variant</code> is not &quot;temporary&quot;",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorTop\">.MuiDrawer-anchorTop</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorLeft": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"left\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorLeft\">.MuiDrawer-anchorLeft</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorRight": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"right\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorRight\">.MuiDrawer-anchorRight</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "paperAnchorTop": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>anchor=\"top\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorTop\">.MuiDrawer-anchorTop</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
    },
    "root": { "description": "Styles applied to the root element." }
  },
  "slotDescriptions": { "swipeArea": "The component used for the swipeArea slot." }
}