Skip to content

refactor: rename internal api #522

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

Merged
merged 1 commit into from
Mar 25, 2025
Merged

refactor: rename internal api #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/examples/body-overflow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export default () => {
<Trigger
arrow
popupVisible={open}
onPopupVisibleChange={(next) => {
onOpenChange={(next) => {
console.log('Visible Change:', next);
setOpen(next);
}}
Expand Down Expand Up @@ -100,7 +100,7 @@ export default () => {
arrow
action="click"
popupVisible={open1}
onPopupVisibleChange={(next) => {
onOpenChange={(next) => {
console.log('Visible Change:', next);
setOpen1(next);
}}
Expand Down Expand Up @@ -156,7 +156,7 @@ export default () => {
arrow
action="contextMenu"
popupVisible={open2}
onPopupVisibleChange={(next) => {
onOpenChange={(next) => {
console.log('Visible Change:', next);
setOpen2(next);
}}
Expand Down Expand Up @@ -205,7 +205,7 @@ export default () => {
arrow
action="contextMenu"
popupVisible={open3}
onPopupVisibleChange={(next) => {
onOpenChange={(next) => {
console.log('Visible Change:', next);
setOpen3(next);
}}
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/click-nested.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const NestPopup = ({ open, setOpen }) => {
builtinPlacements={builtinPlacements}
popup={<div style={popupBorderStyle}>i am a click popup</div>}
popupVisible={open}
onPopupVisibleChange={setOpen}
onOpenChange={setOpen}
>
<div style={popupBorderStyle}>
i am a click popup{' '}
Expand Down Expand Up @@ -77,7 +77,7 @@ const Test = () => {
action={['click']}
builtinPlacements={builtinPlacements}
popupVisible={open1}
onPopupVisibleChange={setOpen1}
onOpenChange={setOpen1}
popup={
// Level 2
<NestPopup open={open2} setOpen={setOpen2} />
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/container.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ export default () => {
}}
popupStyle={{ boxShadow: '0 0 5px red' }}
popupVisible={visible}
onPopupVisibleChange={(nextVisible) => {
onOpenChange={(nextVisible) => {
setVisible(nextVisible);
}}
// getPopupContainer={() => popHolderRef.current}
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/portal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ const Test = () => {
<PortalPopup />
</div>
}
onPopupVisibleChange={(visible) => {
onOpenChange={(visible) => {
console.log('visible change:', visible);
}}
>
Expand Down
6 changes: 3 additions & 3 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export interface TriggerProps {
// ==================== Open =====================
popupVisible?: boolean;
defaultPopupVisible?: boolean;
onPopupVisibleChange?: (visible: boolean) => void;
onOpenChange?: (visible: boolean) => void;
afterPopupVisibleChange?: (visible: boolean) => void;

// =================== Portal ====================
Expand Down Expand Up @@ -138,7 +138,7 @@ export function generateTrigger(
// Open
popupVisible,
defaultPopupVisible,
onPopupVisibleChange,
onOpenChange,
afterPopupVisibleChange,

// Delay
Expand Down Expand Up @@ -299,7 +299,7 @@ export function generateTrigger(
mergedOpen) !== nextOpen
) {
lastTriggerRef.current.push(nextOpen);
onPopupVisibleChange?.(nextOpen);
onOpenChange?.(nextOpen);
}
});

Expand Down
46 changes: 23 additions & 23 deletions tests/basic.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,13 +433,13 @@ describe('Trigger.Basic', () => {
},
};
let innerVisible = null;
function onInnerPopupVisibleChange(value) {
function onInnerOpenChange(value) {
innerVisible = value;
}
const innerTrigger = (
<div style={{ background: 'rgba(255, 0, 0, 0.3)' }}>
<Trigger
onPopupVisibleChange={onInnerPopupVisibleChange}
onOpenChange={onInnerOpenChange}
popupPlacement="right"
action={['click']}
builtinPlacements={builtinPlacements}
Expand All @@ -458,12 +458,12 @@ describe('Trigger.Basic', () => {
);

let visible = null;
function onPopupVisibleChange(value) {
function onOpenChange(value) {
visible = value;
}
const { container } = render(
<Trigger
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
popupPlacement="right"
action={['click']}
builtinPlacements={builtinPlacements}
Expand Down Expand Up @@ -978,11 +978,11 @@ describe('Trigger.Basic', () => {

describe('click window to hide', () => {
it('should hide', async () => {
const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();

const { container } = render(
<Trigger
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
action="click"
popup={<strong>trigger</strong>}
>
Expand All @@ -992,22 +992,22 @@ describe('Trigger.Basic', () => {

fireEvent.click(container.querySelector('.target'));
await awaitFakeTimer();
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
onPopupVisibleChange.mockReset();
expect(onOpenChange).toHaveBeenCalledWith(true);
onOpenChange.mockReset();

// Click outside to close
fireEvent.mouseDown(document.body);
fireEvent.click(document.body);
await awaitFakeTimer();
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
expect(onOpenChange).toHaveBeenCalledWith(false);
});

it('should not hide when mouseDown inside but mouseUp outside', async () => {
const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();

const { container } = render(
<Trigger
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
action="click"
popup={<strong>trigger</strong>}
>
Expand All @@ -1017,14 +1017,14 @@ describe('Trigger.Basic', () => {

fireEvent.click(container.querySelector('.target'));
await awaitFakeTimer();
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
onPopupVisibleChange.mockReset();
expect(onOpenChange).toHaveBeenCalledWith(true);
onOpenChange.mockReset();

// Click outside to close
fireEvent.mouseDown(document.querySelector('strong'));
fireEvent.click(document.body);
await awaitFakeTimer();
expect(onPopupVisibleChange).not.toHaveBeenCalled();
expect(onOpenChange).not.toHaveBeenCalled();
});

// https://github.com/ant-design/ant-design/issues/42526
Expand All @@ -1039,7 +1039,7 @@ describe('Trigger.Basic', () => {
}}
/>
<Trigger
onPopupVisibleChange={setOpen}
onOpenChange={setOpen}
action="click"
popupVisible={open}
popup={<strong>trigger</strong>}
Expand Down Expand Up @@ -1088,11 +1088,11 @@ describe('Trigger.Basic', () => {
});

it('not trigger open when hover hidden popup node', () => {
const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();

const { container } = render(
<Trigger
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
action="hover"
popup={<strong className="popup">trigger</strong>}
getPopupContainer={() => container}
Expand All @@ -1102,15 +1102,15 @@ describe('Trigger.Basic', () => {
);

trigger(container, '.target', 'mouseEnter');
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
onPopupVisibleChange.mockReset();
expect(onOpenChange).toHaveBeenCalledWith(true);
onOpenChange.mockReset();

trigger(container, '.target', 'mouseLeave');
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
onPopupVisibleChange.mockReset();
expect(onOpenChange).toHaveBeenCalledWith(false);
onOpenChange.mockReset();

trigger(container, '.popup', 'mouseEnter');
expect(onPopupVisibleChange).not.toHaveBeenCalled();
expect(onOpenChange).not.toHaveBeenCalled();
});

// https://gith(ub.com/ant-design/ant-design/issues/44830
Expand All @@ -1121,7 +1121,7 @@ describe('Trigger.Basic', () => {
return (
<Trigger
popupVisible={open}
onPopupVisibleChange={setOpen}
onOpenChange={setOpen}
popup={<strong className="x-content">{String(open)}</strong>}
action={['click']}
popupAlign={placementAlignMap.left}
Expand Down
8 changes: 4 additions & 4 deletions tests/portal.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ describe('Trigger.Portal', () => {
);
};

const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();

const { container } = render(
<div className="holder">
<Trigger
action={['hover']}
popupAlign={placementAlignMap.left}
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
popup={
<strong className="x-content">
tooltip2
Expand All @@ -55,7 +55,7 @@ describe('Trigger.Portal', () => {

// Show the popup
fireEvent.mouseEnter(container.querySelector('.target'));
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
expect(onOpenChange).toHaveBeenCalledWith(true);
fireEvent.mouseLeave(container.querySelector('.target'));

// Mouse enter popup
Expand All @@ -68,6 +68,6 @@ describe('Trigger.Portal', () => {
jest.runAllTimers();
});

expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
expect(onOpenChange).toHaveBeenCalledWith(false);
});
});
Loading