Skip to content

refactor: rename visibility change props for clarity #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

refactor: rename visibility change props for clarity #494

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db1da67
refacto: rename visibility change props for clarity
aojunhao123 Mar 26, 2025
b1e392a
refactor: update Tooltip component to use 'open' prop for visibility …
aojunhao123 Mar 26, 2025
bc2de93
fix: ts error
aojunhao123 Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,5 @@ package-lock.json
.dumi/tmp
.dumi/tmp-production

bun.lockb
bun.lockb
.vscode/
23 changes: 10 additions & 13 deletions src/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ export interface TooltipProps
> {
trigger?: ActionType | ActionType[];
defaultVisible?: boolean;
visible?: boolean;
open?: boolean;
placement?: string;
/** Config popup motion */
motion?: TriggerProps['popupMotion'];
onVisibleChange?: (visible: boolean) => void;
afterVisibleChange?: (visible: boolean) => void;
onOpenChange?: (open: boolean) => void;
afterOpenChange?: (open: boolean) => void;
overlay: (() => React.ReactNode) | React.ReactNode;
/** @deprecated Please use `styles={{ root: {} }}` */
overlayStyle?: React.CSSProperties;
Expand Down Expand Up @@ -68,8 +68,8 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
overlayStyle,
prefixCls = 'rc-tooltip',
children,
onVisibleChange,
afterVisibleChange,
onOpenChange,
afterOpenChange,
motion,
placement = 'right',
align = {},
Expand All @@ -83,6 +83,7 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
showArrow = true,
classNames: tooltipClassNames,
styles: tooltipStyles,
open,
...restProps
} = props;

Expand All @@ -91,11 +92,6 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {

useImperativeHandle(ref, () => triggerRef.current);

const extraProps: Partial<TooltipProps & TriggerProps> = { ...restProps };
if ('visible' in props) {
extraProps.popupVisible = props.visible;
}

const getPopupElement = () => (
<Popup
key="content"
Expand Down Expand Up @@ -131,16 +127,17 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
ref={triggerRef}
popupAlign={align}
getPopupContainer={getTooltipContainer}
onPopupVisibleChange={onVisibleChange}
afterPopupVisibleChange={afterVisibleChange}
onOpenChange={onOpenChange}
afterOpenChange={afterOpenChange}
popupMotion={motion}
defaultPopupVisible={defaultVisible}
autoDestroy={destroyTooltipOnHide}
mouseLeaveDelay={mouseLeaveDelay}
popupStyle={{ ...overlayStyle, ...tooltipStyles?.root }}
mouseEnterDelay={mouseEnterDelay}
arrow={showArrow}
{...extraProps}
popupVisible={open}
{...restProps}
>
{getChildren()}
</Trigger>
Expand Down
4 changes: 2 additions & 2 deletions tests/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ describe('rc-tooltip', () => {
const App = () => {
const [open, setOpen] = React.useState(false);
return (
<Tooltip overlay={<strong className="x-content">Tooltip content</strong>} visible={open}>
<Tooltip overlay={<strong className="x-content">Tooltip content</strong>} open={open}>
<div
className="target"
onClick={() => {
Expand Down Expand Up @@ -263,7 +263,7 @@ describe('rc-tooltip', () => {
};

const { container } = render(
<Tooltip classNames={customClassNames} overlay={<div />} styles={customStyles} visible>
<Tooltip classNames={customClassNames} overlay={<div />} styles={customStyles} open>
<button />
</Tooltip>,
);
Expand Down
Loading