react-test/docs/pages/material-ui/api/tooltip.json

{
  "props": {
    "children": { "type": { "name": "custom", "description": "element" }, "required": true },
    "arrow": { "type": { "name": "bool" }, "default": "false" },
    "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
    "components": {
      "type": {
        "name": "shape",
        "description": "{ Arrow?: elementType, Popper?: elementType, Tooltip?: elementType, Transition?: elementType }"
      },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slots</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."
    },
    "componentsProps": {
      "type": {
        "name": "shape",
        "description": "{ arrow?: object, popper?: object, tooltip?: object, transition?: object }"
      },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps</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."
    },
    "describeChild": { "type": { "name": "bool" }, "default": "false" },
    "disableFocusListener": { "type": { "name": "bool" }, "default": "false" },
    "disableHoverListener": { "type": { "name": "bool" }, "default": "false" },
    "disableInteractive": { "type": { "name": "bool" }, "default": "false" },
    "disableTouchListener": { "type": { "name": "bool" }, "default": "false" },
    "enterDelay": { "type": { "name": "number" }, "default": "100" },
    "enterNextDelay": { "type": { "name": "number" }, "default": "0" },
    "enterTouchDelay": { "type": { "name": "number" }, "default": "700" },
    "followCursor": { "type": { "name": "bool" }, "default": "false" },
    "id": { "type": { "name": "string" } },
    "leaveDelay": { "type": { "name": "number" }, "default": "0" },
    "leaveTouchDelay": { "type": { "name": "number" }, "default": "1500" },
    "onClose": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(event: React.SyntheticEvent) => void",
        "describedArgs": ["event"]
      }
    },
    "onOpen": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(event: React.SyntheticEvent) => void",
        "describedArgs": ["event"]
      }
    },
    "open": { "type": { "name": "bool" } },
    "placement": {
      "type": {
        "name": "enum",
        "description": "'auto-end'<br>&#124;&nbsp;'auto-start'<br>&#124;&nbsp;'auto'<br>&#124;&nbsp;'bottom-end'<br>&#124;&nbsp;'bottom-start'<br>&#124;&nbsp;'bottom'<br>&#124;&nbsp;'left-end'<br>&#124;&nbsp;'left-start'<br>&#124;&nbsp;'left'<br>&#124;&nbsp;'right-end'<br>&#124;&nbsp;'right-start'<br>&#124;&nbsp;'right'<br>&#124;&nbsp;'top-end'<br>&#124;&nbsp;'top-start'<br>&#124;&nbsp;'top'"
      },
      "default": "'bottom'"
    },
    "PopperComponent": {
      "type": { "name": "elementType" },
      "deprecated": true,
      "deprecationInfo": "use the <code>slots.popper</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."
    },
    "PopperProps": {
      "type": { "name": "object" },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps.popper</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."
    },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ arrow?: func<br>&#124;&nbsp;object, popper?: func<br>&#124;&nbsp;object, tooltip?: func<br>&#124;&nbsp;object, transition?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ arrow?: elementType, popper?: elementType, tooltip?: elementType, transition?: elementType }"
      },
      "default": "{}"
    },
    "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 }
    },
    "title": { "type": { "name": "node" } },
    "TransitionComponent": {
      "type": { "name": "elementType" },
      "deprecated": true,
      "deprecationInfo": "use the <code>slots.transition</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."
    },
    "TransitionProps": {
      "type": { "name": "object" },
      "default": "{}",
      "deprecated": true,
      "deprecationInfo": "use the <code>slotProps.transition</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."
    }
  },
  "name": "Tooltip",
  "imports": [
    "import Tooltip from '@mui/material/Tooltip';",
    "import { Tooltip } from '@mui/material';"
  ],
  "slots": [
    {
      "name": "popper",
      "description": "The component used for the popper.",
      "default": "Popper",
      "class": "MuiTooltip-popper"
    },
    {
      "name": "transition",
      "description": "The component used for the transition.\n[Follow this guide](https://mui.com/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.",
      "default": "Grow",
      "class": null
    },
    {
      "name": "tooltip",
      "description": "The component used for the tooltip.",
      "class": "MuiTooltip-tooltip"
    },
    {
      "name": "arrow",
      "description": "The component used for the arrow.",
      "class": "MuiTooltip-arrow"
    }
  ],
  "classes": [
    {
      "key": "popperArrow",
      "className": "MuiTooltip-popperArrow",
      "description": "Styles applied to the Popper component if `arrow={true}`.",
      "isGlobal": false
    },
    {
      "key": "popperClose",
      "className": "MuiTooltip-popperClose",
      "description": "Styles applied to the Popper component unless the tooltip is open.",
      "isGlobal": false
    },
    {
      "key": "popperInteractive",
      "className": "MuiTooltip-popperInteractive",
      "description": "Styles applied to the Popper component unless `disableInteractive={true}`.",
      "isGlobal": false
    },
    {
      "key": "tooltipArrow",
      "className": "MuiTooltip-tooltipArrow",
      "description": "Styles applied to the tooltip (label wrapper) element if `arrow={true}`.",
      "isGlobal": false
    },
    {
      "key": "tooltipPlacementBottom",
      "className": "MuiTooltip-tooltipPlacementBottom",
      "description": "Styles applied to the tooltip (label wrapper) element if `placement` contains \"bottom\".",
      "isGlobal": false
    },
    {
      "key": "tooltipPlacementLeft",
      "className": "MuiTooltip-tooltipPlacementLeft",
      "description": "Styles applied to the tooltip (label wrapper) element if `placement` contains \"left\".",
      "isGlobal": false
    },
    {
      "key": "tooltipPlacementRight",
      "className": "MuiTooltip-tooltipPlacementRight",
      "description": "Styles applied to the tooltip (label wrapper) element if `placement` contains \"right\".",
      "isGlobal": false
    },
    {
      "key": "tooltipPlacementTop",
      "className": "MuiTooltip-tooltipPlacementTop",
      "description": "Styles applied to the tooltip (label wrapper) element if `placement` contains \"top\".",
      "isGlobal": false
    },
    {
      "key": "touch",
      "className": "MuiTooltip-touch",
      "description": "Styles applied to the tooltip (label wrapper) element if the tooltip is opened by touch.",
      "isGlobal": false
    }
  ],
  "spread": true,
  "themeDefaultProps": true,
  "muiName": "MuiTooltip",
  "forwardsRefTo": "HTMLButtonElement",
  "filename": "/packages/mui-material/src/Tooltip/Tooltip.js",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/material-ui/react-tooltip/\">Tooltip</a></li></ul>",
  "cssComponent": false
}