[ { "tags": { "param": "props.definition Content that appears in the tooltip.\nprops.tooltipClassName Class name applied to tooltip container." }, "description": "Inline Definition", "methods": [], "displayName": "InlineDefinition", "props": { "InlineDefinitionProps": { "children": { "name": "children", "defaultValue": null, "description": "Trigger element for the definition tooltip", "required": true, "type": { "name": "enum", "raw": "ReactNode", "value": [ { "value": "string" }, { "value": "number" }, { "value": "false" }, { "value": "true" }, { "value": "ReactElement>", "description": "", "fullComment": "", "tags": {} }, { "value": "Iterable", "description": "", "fullComment": "", "tags": {} }, { "value": "ReactPortal", "description": "", "fullComment": "", "tags": {} } ] }, "tags": { "required": "" } }, "definition": { "name": "definition", "defaultValue": null, "description": "ReactNode rendered inside the tooltip", "required": true, "type": { "name": "enum", "raw": "ReactNode", "value": [ { "value": "string" }, { "value": "number" }, { "value": "false" }, { "value": "true" }, { "value": "ReactElement>", "description": "", "fullComment": "", "tags": {} }, { "value": "Iterable", "description": "", "fullComment": "", "tags": {} }, { "value": "ReactPortal", "description": "", "fullComment": "", "tags": {} } ] }, "tags": { "required": "" } }, "tooltipClassName": { "name": "tooltipClassName", "defaultValue": null, "description": "`className` prop passed to the Tooltip component instance", "required": false, "type": { "name": "string" }, "tags": {} }, "className": { "name": "className", "defaultValue": null, "description": "Class name applied to popover container.", "required": false, "type": { "name": "string" }, "tags": {} }, "onClick": { "name": "onClick", "defaultValue": null, "description": "Click event handler passed to the root div element within the portal container.", "required": false, "type": { "name": "MouseEventHandler" }, "tags": {} }, "align": { "name": "align", "defaultValue": { "value": "'top'" }, "description": "Determines the alignment of the popover content relative to the trigger element", "required": false, "type": { "name": "enum", "raw": "Align", "value": [ { "value": "\"top\"" }, { "value": "\"bottom\"" }, { "value": "\"left\"" }, { "value": "\"right\"" } ] }, "tags": { "default": "'top'" } }, "justify": { "name": "justify", "defaultValue": null, "description": "Determines the justification of the popover content relative to the trigger element\n\ndefault: `start`", "required": false, "type": { "name": "enum", "raw": "Justify", "value": [ { "value": "\"start\"" }, { "value": "\"middle\"" }, { "value": "\"end\"" } ] }, "tags": {} }, "maxHeight": { "name": "maxHeight", "defaultValue": { "value": "undefined" }, "description": "Restricts the height of the popover.\nIf the `maxHeight` provided is _greater than_ the available space above or below the reference element,\nthe height will be restricted to the available space (i.e. the popover will not overflow the viewport).\n\nNote: Any `max-height` applied with additional CSS will take precedence, and will override the \"available space\" calculation", "required": false, "type": { "name": "number" }, "tags": { "default": "undefined" } }, "maxWidth": { "name": "maxWidth", "defaultValue": { "value": "undefined" }, "description": "Restricts the width of the popover.\nIf the `maxWidth` provided is _greater than_ the available space left or right of the referent element,\nthe width will be restricted to the available space (i.e. the popover will not overflow the viewport).\n\nNote: Any `max-width` applied with additional CSS will take precedence, and will override the \"available space\" calculation", "required": false, "type": { "name": "number" }, "tags": { "default": "undefined" } }, "refEl": { "name": "refEl", "defaultValue": null, "description": "A reference to the element against which the popover component will be positioned.", "required": false, "type": { "name": "RefObject" }, "tags": {} }, "spacing": { "name": "spacing", "defaultValue": null, "description": "Specifies the amount of spacing (in pixels) between the trigger element and the Popover content.\n\ndefault: `4`", "required": false, "type": { "name": "number" }, "tags": {} }, "trigger": { "name": "trigger", "defaultValue": null, "description": "A slot for the element used to trigger the `Tooltip`.\n\nNote: The component passed as `trigger` _must_ accept and render `children`,\neven if the general use of the component does not require children.\nThe `tooltip` content is rendered (via `Popover`) as a child of the trigger,\nand if the trigger does not render any children, then the trigger will not be rendered.", "required": false, "type": { "name": "enum", "raw": "ReactElement> | ((props: any) => ReactElement>)", "value": [ { "value": "ReactElement>", "description": "", "fullComment": "", "tags": {} }, { "value": "(props: any) => ReactElement>", "description": "", "fullComment": "", "tags": {} } ] }, "tags": {} }, "triggerEvent": { "name": "triggerEvent", "defaultValue": { "value": "'hover'" }, "description": "Determines if a `hover` or `click` event will trigger the opening of a `Tooltip`.", "required": false, "type": { "name": "enum", "raw": "TriggerEvent", "value": [ { "value": "\"hover\"" }, { "value": "\"click\"" } ] }, "tags": { "default": "'hover'" } }, "initialOpen": { "name": "initialOpen", "defaultValue": { "value": "`false`" }, "description": "Provides an initial value to uncontrolled open/setOpen state", "required": false, "type": { "name": "enum", "raw": "boolean", "value": [ { "value": "false" }, { "value": "true" } ] }, "tags": { "default": "`false`" } }, "open": { "name": "open", "defaultValue": { "value": "`false`" }, "description": "Controls component and determines the open state of the `Tooltip`", "required": false, "type": { "name": "enum", "raw": "boolean", "value": [ { "value": "false" }, { "value": "true" } ] }, "tags": { "default": "`false`" } }, "setOpen": { "name": "setOpen", "defaultValue": null, "description": "Callback to change the open state of the `Tooltip`.", "required": false, "type": { "name": "Dispatch>" }, "tags": {} }, "darkMode": { "name": "darkMode", "defaultValue": { "value": "false" }, "description": "Whether the `Tooltip` will appear in dark mode.", "required": false, "type": { "name": "enum", "raw": "boolean", "value": [ { "value": "false" }, { "value": "true" } ] }, "tags": { "default": "false" } }, "shouldClose": { "name": "shouldClose", "defaultValue": null, "description": "Callback to determine whether or not `Tooltip` should close when user tries to close it.", "required": false, "type": { "name": "() => boolean" }, "tags": {} }, "enabled": { "name": "enabled", "defaultValue": { "value": "true" }, "description": "Enables Tooltip to trigger based on the event specified by `triggerEvent`.", "required": false, "type": { "name": "enum", "raw": "boolean", "value": [ { "value": "false" }, { "value": "true" } ] }, "tags": { "default": "true" } }, "onClose": { "name": "onClose", "defaultValue": null, "description": "Callback that is called when the tooltip is closed internally. E.g. on ESC press, on backdrop click, on blur.", "required": false, "type": { "name": "() => void" }, "tags": {} }, "baseFontSize": { "name": "baseFontSize", "defaultValue": null, "description": "Allows consuming applications to override font-size as set by the LeafyGreen Provider.", "required": false, "type": { "name": "enum", "raw": "BaseFontSize", "value": [ { "value": "13" }, { "value": "16" } ] }, "tags": { "remarks": "This prop is only considered when variant is 'default'" } }, "variant": { "name": "variant", "defaultValue": { "value": "'default'" }, "description": "Variant of the tooltip to be rendered.", "required": false, "type": { "name": "enum", "raw": "TooltipVariant", "value": [ { "value": "\"default\"" }, { "value": "\"compact\"" } ] }, "tags": { "default": "'default'" } } }, "HTMLAttributes": "https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes", "AriaAttributes": "https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes", "DOMAttributes": "https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes", "BaseTransitionProps": { "onEnter": { "name": "onEnter", "defaultValue": null, "description": "Callback fired before the \"entering\" status is applied. An extra\nparameter `isAppearing` is supplied to indicate if the enter stage is\noccurring on the initial mount", "required": false, "type": { "name": "(isAppearing: boolean) => void" }, "tags": {} }, "onEntering": { "name": "onEntering", "defaultValue": null, "description": "Callback fired after the \"entering\" status is applied. An extra parameter\nisAppearing is supplied to indicate if the enter stage is occurring on\nthe initial mount", "required": false, "type": { "name": "(isAppearing: boolean) => void" }, "tags": {} }, "onEntered": { "name": "onEntered", "defaultValue": null, "description": "Callback fired after the \"entered\" status is applied. An extra parameter\nisAppearing is supplied to indicate if the enter stage is occurring on\nthe initial mount", "required": false, "type": { "name": "(isAppearing: boolean) => void" }, "tags": {} }, "onExit": { "name": "onExit", "defaultValue": null, "description": "Callback fired before the \"exiting\" status is applied.", "required": false, "type": { "name": "() => void" }, "tags": {} }, "onExiting": { "name": "onExiting", "defaultValue": null, "description": "Callback fired after the \"exiting\" status is applied.", "required": false, "type": { "name": "() => void" }, "tags": {} }, "onExited": { "name": "onExited", "defaultValue": null, "description": "Callback fired after the \"exited\" status is applied.", "required": false, "type": { "name": "() => void" }, "tags": {} } } } } ]