type: add deprecated info for overlayClassName (#486)

* type: add deprecated info for overlayClassName * fix * fix
react-component · Dec 4, 2024 · dcae397 · dcae397 · vercel · Dec 4, 2024
1 parent 2679015
commit dcae397
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ Online demo: <https://react-component.github.io/tooltip/demo>
 | afterVisibleChange   | (visible: boolean) => void;               |                     | Callback after visible change                                                                                                                                    |
 | overlay              | ReactNode \| () => ReactNode              |                     | tooltip overlay content                                                                                                                                          |
 | overlayStyle         | object                                    |                     | deprecated, Please use `styles={{ root: {} }}`                                                                                                                                         |
-| overlayClassName     | string                                    |                     | className of tooltip overlay                                                                                                                                     |
+| overlayClassName     | string                                    |                     | deprecated, Please use `classNames={{ root: {} }}`                                                                                                                                 |
 | prefixCls            | string                                    | 'rc-tooltip'        | prefix class name of tooltip                                                                                                                                     |
 | mouseEnterDelay      | number                                    | 0                   | delay time (in second) before tooltip shows when mouse enter                                                                                                     |
 | mouseLeaveDelay      | number                                    | 0.1                 | delay time (in second) before tooltip hides when mouse leave                                                                                                     |

diff --git a/src/Tooltip.tsx b/src/Tooltip.tsx
@@ -35,6 +35,7 @@ export interface TooltipProps
   overlay: (() => React.ReactNode) | React.ReactNode;
   /** @deprecated Please use `styles={{ root: {} }}` */
   overlayStyle?: React.CSSProperties;
+  /** @deprecated Please use `classNames={{ root: {} }}` */
   overlayClassName?: string;
   getTooltipContainer?: (node: HTMLElement) => HTMLElement;
   destroyTooltipOnHide?: boolean;