Skip to content

Commit 9601b4a

Browse files
aojunhao123aojunhao123
authored
refactor: rename onPopupVisibleChange to onOpenChange (#522)
1 parent 1b12692 commit 9601b4a

File tree

7 files changed

+38
-38
lines changed

7 files changed

+38
-38
lines changed

‎docs/examples/body-overflow.tsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export default () => {
4141
<Trigger
4242
arrow
4343
popupVisible={open}
44-
onPopupVisibleChange={(next) => {
44+
onOpenChange={(next) => {
4545
console.log('Visible Change:', next);
4646
setOpen(next);
4747
}}
@@ -100,7 +100,7 @@ export default () => {
100100
arrow
101101
action="click"
102102
popupVisible={open1}
103-
onPopupVisibleChange={(next) => {
103+
onOpenChange={(next) => {
104104
console.log('Visible Change:', next);
105105
setOpen1(next);
106106
}}
@@ -156,7 +156,7 @@ export default () => {
156156
arrow
157157
action="contextMenu"
158158
popupVisible={open2}
159-
onPopupVisibleChange={(next) => {
159+
onOpenChange={(next) => {
160160
console.log('Visible Change:', next);
161161
setOpen2(next);
162162
}}
@@ -205,7 +205,7 @@ export default () => {
205205
arrow
206206
action="contextMenu"
207207
popupVisible={open3}
208-
onPopupVisibleChange={(next) => {
208+
onOpenChange={(next) => {
209209
console.log('Visible Change:', next);
210210
setOpen3(next);
211211
}}

‎docs/examples/click-nested.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ const NestPopup = ({ open, setOpen }) => {
4545
builtinPlacements={builtinPlacements}
4646
popup={<div style={popupBorderStyle}>i am a click popup</div>}
4747
popupVisible={open}
48-
onPopupVisibleChange={setOpen}
48+
onOpenChange={setOpen}
4949
>
5050
<div style={popupBorderStyle}>
5151
i am a click popup{' '}
@@ -77,7 +77,7 @@ const Test = () => {
7777
action={['click']}
7878
builtinPlacements={builtinPlacements}
7979
popupVisible={open1}
80-
onPopupVisibleChange={setOpen1}
80+
onOpenChange={setOpen1}
8181
popup={
8282
// Level 2
8383
<NestPopup open={open2} setOpen={setOpen2} />

‎docs/examples/container.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ export default () => {
165165
}}
166166
popupStyle={{ boxShadow: '0 0 5px red' }}
167167
popupVisible={visible}
168-
onPopupVisibleChange={(nextVisible) => {
168+
onOpenChange={(nextVisible) => {
169169
setVisible(nextVisible);
170170
}}
171171
// getPopupContainer={() => popHolderRef.current}

‎docs/examples/portal.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ const Test = () => {
8686
<PortalPopup />
8787
</div>
8888
}
89-
onPopupVisibleChange={(visible) => {
89+
onOpenChange={(visible) => {
9090
console.log('visible change:', visible);
9191
}}
9292
>

‎src/index.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export interface TriggerProps {
6262
// ==================== Open =====================
6363
popupVisible?: boolean;
6464
defaultPopupVisible?: boolean;
65-
onPopupVisibleChange?: (visible: boolean) => void;
65+
onOpenChange?: (visible: boolean) => void;
6666
afterPopupVisibleChange?: (visible: boolean) => void;
6767

6868
// =================== Portal ====================
@@ -138,7 +138,7 @@ export function generateTrigger(
138138
// Open
139139
popupVisible,
140140
defaultPopupVisible,
141-
onPopupVisibleChange,
141+
onOpenChange,
142142
afterPopupVisibleChange,
143143

144144
// Delay
@@ -299,7 +299,7 @@ export function generateTrigger(
299299
mergedOpen) !== nextOpen
300300
) {
301301
lastTriggerRef.current.push(nextOpen);
302-
onPopupVisibleChange?.(nextOpen);
302+
onOpenChange?.(nextOpen);
303303
}
304304
});
305305

‎tests/basic.test.jsx‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -433,13 +433,13 @@ describe('Trigger.Basic', () => {
433433
},
434434
};
435435
let innerVisible = null;
436-
function onInnerPopupVisibleChange(value) {
436+
function onInnerOpenChange(value) {
437437
innerVisible = value;
438438
}
439439
const innerTrigger = (
440440
<div style={{ background: 'rgba(255, 0, 0, 0.3)' }}>
441441
<Trigger
442-
onPopupVisibleChange={onInnerPopupVisibleChange}
442+
onOpenChange={onInnerOpenChange}
443443
popupPlacement="right"
444444
action={['click']}
445445
builtinPlacements={builtinPlacements}
@@ -458,12 +458,12 @@ describe('Trigger.Basic', () => {
458458
);
459459

460460
let visible = null;
461-
function onPopupVisibleChange(value) {
461+
function onOpenChange(value) {
462462
visible = value;
463463
}
464464
const { container } = render(
465465
<Trigger
466-
onPopupVisibleChange={onPopupVisibleChange}
466+
onOpenChange={onOpenChange}
467467
popupPlacement="right"
468468
action={['click']}
469469
builtinPlacements={builtinPlacements}
@@ -978,11 +978,11 @@ describe('Trigger.Basic', () => {
978978

979979
describe('click window to hide', () => {
980980
it('should hide', async () => {
981-
const onPopupVisibleChange = jest.fn();
981+
const onOpenChange = jest.fn();
982982

983983
const { container } = render(
984984
<Trigger
985-
onPopupVisibleChange={onPopupVisibleChange}
985+
onOpenChange={onOpenChange}
986986
action="click"
987987
popup={<strong>trigger</strong>}
988988
>
@@ -992,22 +992,22 @@ describe('Trigger.Basic', () => {
992992

993993
fireEvent.click(container.querySelector('.target'));
994994
await awaitFakeTimer();
995-
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
996-
onPopupVisibleChange.mockReset();
995+
expect(onOpenChange).toHaveBeenCalledWith(true);
996+
onOpenChange.mockReset();
997997

998998
// Click outside to close
999999
fireEvent.mouseDown(document.body);
10001000
fireEvent.click(document.body);
10011001
await awaitFakeTimer();
1002-
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
1002+
expect(onOpenChange).toHaveBeenCalledWith(false);
10031003
});
10041004

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

10081008
const { container } = render(
10091009
<Trigger
1010-
onPopupVisibleChange={onPopupVisibleChange}
1010+
onOpenChange={onOpenChange}
10111011
action="click"
10121012
popup={<strong>trigger</strong>}
10131013
>
@@ -1017,14 +1017,14 @@ describe('Trigger.Basic', () => {
10171017

10181018
fireEvent.click(container.querySelector('.target'));
10191019
await awaitFakeTimer();
1020-
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
1021-
onPopupVisibleChange.mockReset();
1020+
expect(onOpenChange).toHaveBeenCalledWith(true);
1021+
onOpenChange.mockReset();
10221022

10231023
// Click outside to close
10241024
fireEvent.mouseDown(document.querySelector('strong'));
10251025
fireEvent.click(document.body);
10261026
await awaitFakeTimer();
1027-
expect(onPopupVisibleChange).not.toHaveBeenCalled();
1027+
expect(onOpenChange).not.toHaveBeenCalled();
10281028
});
10291029

10301030
// https://github.com/ant-design/ant-design/issues/42526
@@ -1039,7 +1039,7 @@ describe('Trigger.Basic', () => {
10391039
}}
10401040
/>
10411041
<Trigger
1042-
onPopupVisibleChange={setOpen}
1042+
onOpenChange={setOpen}
10431043
action="click"
10441044
popupVisible={open}
10451045
popup={<strong>trigger</strong>}
@@ -1088,11 +1088,11 @@ describe('Trigger.Basic', () => {
10881088
});
10891089

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

10931093
const { container } = render(
10941094
<Trigger
1095-
onPopupVisibleChange={onPopupVisibleChange}
1095+
onOpenChange={onOpenChange}
10961096
action="hover"
10971097
popup={<strong className="popup">trigger</strong>}
10981098
getPopupContainer={() => container}
@@ -1102,15 +1102,15 @@ describe('Trigger.Basic', () => {
11021102
);
11031103

11041104
trigger(container, '.target', 'mouseEnter');
1105-
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
1106-
onPopupVisibleChange.mockReset();
1105+
expect(onOpenChange).toHaveBeenCalledWith(true);
1106+
onOpenChange.mockReset();
11071107

11081108
trigger(container, '.target', 'mouseLeave');
1109-
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
1110-
onPopupVisibleChange.mockReset();
1109+
expect(onOpenChange).toHaveBeenCalledWith(false);
1110+
onOpenChange.mockReset();
11111111

11121112
trigger(container, '.popup', 'mouseEnter');
1113-
expect(onPopupVisibleChange).not.toHaveBeenCalled();
1113+
expect(onOpenChange).not.toHaveBeenCalled();
11141114
});
11151115

11161116
// https://gith(ub.com/ant-design/ant-design/issues/44830
@@ -1121,7 +1121,7 @@ describe('Trigger.Basic', () => {
11211121
return (
11221122
<Trigger
11231123
popupVisible={open}
1124-
onPopupVisibleChange={setOpen}
1124+
onOpenChange={setOpen}
11251125
popup={<strong className="x-content">{String(open)}</strong>}
11261126
action={['click']}
11271127
popupAlign={placementAlignMap.left}

‎tests/portal.test.jsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ describe('Trigger.Portal', () => {
3333
);
3434
};
3535

36-
const onPopupVisibleChange = jest.fn();
36+
const onOpenChange = jest.fn();
3737

3838
const { container } = render(
3939
<div className="holder">
4040
<Trigger
4141
action={['hover']}
4242
popupAlign={placementAlignMap.left}
43-
onPopupVisibleChange={onPopupVisibleChange}
43+
onOpenChange={onOpenChange}
4444
popup={
4545
<strong className="x-content">
4646
tooltip2
@@ -55,7 +55,7 @@ describe('Trigger.Portal', () => {
5555

5656
// Show the popup
5757
fireEvent.mouseEnter(container.querySelector('.target'));
58-
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
58+
expect(onOpenChange).toHaveBeenCalledWith(true);
5959
fireEvent.mouseLeave(container.querySelector('.target'));
6060

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

71-
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
71+
expect(onOpenChange).toHaveBeenCalledWith(false);
7272
});
7373
});

0 commit comments

Comments
 (0)