Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
128 lines
6.4 KiB
JSON
128 lines
6.4 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"arrow": { "description": "If <code>true</code>, adds an arrow to the tooltip." },
|
|
"children": { "description": "Tooltip reference element.", "requiresRef": true },
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"components": { "description": "The components used for each slot inside." },
|
|
"componentsProps": {
|
|
"description": "The extra props for the slot components. You can override the existing props or add new ones."
|
|
},
|
|
"describeChild": {
|
|
"description": "Set to <code>true</code> if the <code>title</code> acts as an accessible description. By default the <code>title</code> acts as an accessible label for the child."
|
|
},
|
|
"disableFocusListener": { "description": "Do not respond to focus-visible events." },
|
|
"disableHoverListener": { "description": "Do not respond to hover events." },
|
|
"disableInteractive": {
|
|
"description": "Makes a tooltip not interactive, i.e. it will close when the user hovers over the tooltip before the <code>leaveDelay</code> is expired."
|
|
},
|
|
"disableTouchListener": { "description": "Do not respond to long press touch events." },
|
|
"enterDelay": {
|
|
"description": "The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (<code>enterTouchDelay</code>)."
|
|
},
|
|
"enterNextDelay": {
|
|
"description": "The number of milliseconds to wait before showing the tooltip when one was already recently opened."
|
|
},
|
|
"enterTouchDelay": {
|
|
"description": "The number of milliseconds a user must touch the element before showing the tooltip."
|
|
},
|
|
"followCursor": {
|
|
"description": "If <code>true</code>, the tooltip follow the cursor over the wrapped element."
|
|
},
|
|
"id": {
|
|
"description": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id."
|
|
},
|
|
"leaveDelay": {
|
|
"description": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (<code>leaveTouchDelay</code>)."
|
|
},
|
|
"leaveTouchDelay": {
|
|
"description": "The number of milliseconds after the user stops touching an element before hiding the tooltip."
|
|
},
|
|
"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 open.",
|
|
"typeDescriptions": {
|
|
"event": { "name": "event", "description": "The event source of the callback." }
|
|
}
|
|
},
|
|
"open": { "description": "If <code>true</code>, the component is shown." },
|
|
"placement": { "description": "Tooltip placement." },
|
|
"PopperComponent": { "description": "The component used for the popper." },
|
|
"PopperProps": {
|
|
"description": "Props applied to the <a href=\"https://mui.com/material-ui/api/popper/\"><code>Popper</code></a> element."
|
|
},
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
|
"slots": { "description": "The components used for each slot inside." },
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
},
|
|
"title": {
|
|
"description": "Tooltip title. Zero-length titles string, undefined, null and false are never displayed."
|
|
},
|
|
"TransitionComponent": {
|
|
"description": "The component used for the transition. <a href=\"https://mui.com/material-ui/transitions/#transitioncomponent-prop\">Follow this guide</a> to learn more about the requirements for this component."
|
|
},
|
|
"TransitionProps": {
|
|
"description": "Props applied to the transition element. By default, the element is based on this <a href=\"https://reactcommunity.org/react-transition-group/transition/\"><code>Transition</code></a> component."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"popperArrow": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the Popper component",
|
|
"conditions": "<code>arrow={true}</code>"
|
|
},
|
|
"popperClose": {
|
|
"description": "Styles applied to {{nodeName}} unless {{conditions}}.",
|
|
"nodeName": "the Popper component",
|
|
"conditions": "the tooltip is open"
|
|
},
|
|
"popperInteractive": {
|
|
"description": "Styles applied to {{nodeName}} unless {{conditions}}.",
|
|
"nodeName": "the Popper component",
|
|
"conditions": "<code>disableInteractive={true}</code>"
|
|
},
|
|
"tooltipArrow": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the tooltip (label wrapper) element",
|
|
"conditions": "<code>arrow={true}</code>"
|
|
},
|
|
"tooltipPlacementBottom": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the tooltip (label wrapper) element",
|
|
"conditions": "<code>placement</code> contains "bottom""
|
|
},
|
|
"tooltipPlacementLeft": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the tooltip (label wrapper) element",
|
|
"conditions": "<code>placement</code> contains "left""
|
|
},
|
|
"tooltipPlacementRight": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the tooltip (label wrapper) element",
|
|
"conditions": "<code>placement</code> contains "right""
|
|
},
|
|
"tooltipPlacementTop": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the tooltip (label wrapper) element",
|
|
"conditions": "<code>placement</code> contains "top""
|
|
},
|
|
"touch": {
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the tooltip (label wrapper) element",
|
|
"conditions": "the tooltip is opened by touch"
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"arrow": "The component used for the arrow.",
|
|
"popper": "The component used for the popper.",
|
|
"tooltip": "The component used for the tooltip.",
|
|
"transition": "The component used for the transition. <a href=\"https://mui.com/material-ui/transitions/#transitioncomponent-prop\">Follow this guide</a> to learn more about the requirements for this component."
|
|
}
|
|
}
|