181 lines
8.2 KiB
JSON
181 lines
8.2 KiB
JSON
|
|
{
|
||
|
|
"componentDescription": "",
|
||
|
|
"propDescriptions": {
|
||
|
|
"arrow": { "description": "If <code>true</code>, adds an arrow to the tooltip." },
|
||
|
|
"children": { "description": "Tooltip reference element." },
|
||
|
|
"color": {
|
||
|
|
"description": "The color of the component. It supports those theme colors that make sense for this component."
|
||
|
|
},
|
||
|
|
"component": {
|
||
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
"direction": { "description": "Direction of the text." },
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
"disablePortal": {
|
||
|
|
"description": "The <code>children</code> will be under the DOM hierarchy of the parent component."
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
"keepMounted": {
|
||
|
|
"description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper."
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
"modifiers": {
|
||
|
|
"description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".<br>A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, <a href=\"https://popper.js.org/docs/v2/modifiers/\">read the modifiers documentation</a>."
|
||
|
|
},
|
||
|
|
"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." },
|
||
|
|
"size": { "description": "The size of the component." },
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
"variant": {
|
||
|
|
"description": "The <a href=\"https://mui.com/joy-ui/main-features/global-variants/\">global variant</a> to use."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"classDescriptions": {
|
||
|
|
"colorContext": {
|
||
|
|
"description": "Class name applied to {{nodeName}} when {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "color inversion is triggered"
|
||
|
|
},
|
||
|
|
"colorDanger": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"danger\"</code>"
|
||
|
|
},
|
||
|
|
"colorNeutral": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"neutral\"</code>"
|
||
|
|
},
|
||
|
|
"colorPrimary": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"primary\"</code>"
|
||
|
|
},
|
||
|
|
"colorSuccess": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"success\"</code>"
|
||
|
|
},
|
||
|
|
"colorWarning": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>color=\"warning\"</code>"
|
||
|
|
},
|
||
|
|
"placementBottom": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>placement</code> contains "bottom""
|
||
|
|
},
|
||
|
|
"placementLeft": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>placement</code> contains "left""
|
||
|
|
},
|
||
|
|
"placementRight": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>placement</code> contains "right""
|
||
|
|
},
|
||
|
|
"placementTop": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>placement</code> contains "top""
|
||
|
|
},
|
||
|
|
"sizeLg": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>size=\"lg\"</code>"
|
||
|
|
},
|
||
|
|
"sizeMd": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>size=\"md\"</code>"
|
||
|
|
},
|
||
|
|
"sizeSm": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>size=\"sm\"</code>"
|
||
|
|
},
|
||
|
|
"tooltipArrow": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>arrow={true}</code>"
|
||
|
|
},
|
||
|
|
"touch": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "the tooltip is opened by touch"
|
||
|
|
},
|
||
|
|
"variantOutlined": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"outlined\"</code>"
|
||
|
|
},
|
||
|
|
"variantPlain": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"plain\"</code>"
|
||
|
|
},
|
||
|
|
"variantSoft": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"soft\"</code>"
|
||
|
|
},
|
||
|
|
"variantSolid": {
|
||
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>variant=\"solid\"</code>"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"slotDescriptions": {
|
||
|
|
"arrow": "The component that renders the arrow.",
|
||
|
|
"root": "The component that renders the root."
|
||
|
|
}
|
||
|
|
}
|