Fix jsdoc

mui · Sep 13, 2024 · f9e5d16 · f9e5d16
1 parent d398556
commit f9e5d16
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/data/translations/api-docs/tooltip-root/tooltip-root.json b/docs/data/translations/api-docs/tooltip-root/tooltip-root.json
@@ -16,7 +16,7 @@
       "description": "Whether the can move their cursor from the trigger element toward the tooltip popup element without it closing using a &quot;safe polygon&quot; technique."
     },
     "onOpenChange": {
-      "description": "Callback fired when the tooltip popup is requested to be opened or closed."
+      "description": "Callback fired when the tooltip popup is requested to be opened or closed. Use when controlled."
     },
     "open": { "description": "Whether the tooltip popup is open. Use when controlled." },
     "trackCursorAxis": {

diff --git a/packages/mui-base/src/Tooltip/Root/TooltipRoot.tsx b/packages/mui-base/src/Tooltip/Root/TooltipRoot.tsx
@@ -155,7 +155,7 @@ TooltipRoot.propTypes /* remove-proptypes */ = {
    */
   hoverable: PropTypes.bool,
   /**
-   * Callback fired when the tooltip popup is requested to be opened or closed.
+   * Callback fired when the tooltip popup is requested to be opened or closed. Use when controlled.
    */
   onOpenChange: PropTypes.func,
   /**

diff --git a/packages/mui-base/src/Tooltip/Root/useTooltipRoot.ts b/packages/mui-base/src/Tooltip/Root/useTooltipRoot.ts
@@ -199,7 +199,7 @@ export namespace useTooltipRoot {
      */
     open?: boolean;
     /**
-     * Callback fired when the tooltip popup is requested to be opened or closed.
+     * Callback fired when the tooltip popup is requested to be opened or closed. Use when controlled.
      */
     onOpenChange?: (isOpen: boolean, event?: Event, reason?: OpenChangeReason) => void;
     /**