Skip to content

Commit 323c48f

Browse files
committed
refactor: rename onPopupVisibleChange to onOpenChange across components
1 parent 3639a8a commit 323c48f

File tree

7 files changed

+23
-26
lines changed

7 files changed

+23
-26
lines changed

docs/examples/controlled.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class Controlled extends React.Component<{}, ControlledState> {
4343
console.log('onFocus');
4444
};
4545

46-
onPopupVisibleChange = (open) => {
46+
onOpenChange = (open) => {
4747
this.setState({ open });
4848
};
4949

@@ -68,7 +68,7 @@ class Controlled extends React.Component<{}, ControlledState> {
6868
optionLabelProp="children"
6969
optionFilterProp="text"
7070
onChange={this.onChange}
71-
onPopupVisibleChange={this.onPopupVisibleChange}
71+
onOpenChange={this.onOpenChange}
7272
>
7373
<Option value="01" text="jack" title="jack">
7474
<b

src/BaseSelect/index.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ export interface BaseSelectProps extends BaseSelectPrivateProps, React.AriaAttri
162162
// >>> Open
163163
open?: boolean;
164164
defaultOpen?: boolean;
165-
onPopupVisibleChange?: (open: boolean) => void;
165+
onOpenChange?: (open: boolean) => void;
166166

167167
// >>> Customize Input
168168
/** @private Internal usage. Do not use in your production. */
@@ -257,7 +257,7 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
257257
// Open
258258
open,
259259
defaultOpen,
260-
onPopupVisibleChange,
260+
onOpenChange,
261261

262262
// Active
263263
activeValue,
@@ -401,11 +401,11 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
401401
setInnerOpen(nextOpen);
402402

403403
if (mergedOpen !== nextOpen) {
404-
onPopupVisibleChange?.(nextOpen);
404+
onOpenChange?.(nextOpen);
405405
}
406406
}
407407
},
408-
[disabled, mergedOpen, setInnerOpen, onPopupVisibleChange],
408+
[disabled, mergedOpen, setInnerOpen, onOpenChange],
409409
);
410410

411411
// ============================= Search =============================
@@ -814,7 +814,7 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
814814
// But we should update `rc-resize-observer` first.
815815
selectorDomRef.current || node
816816
}
817-
onPopupVisibleChange={onTriggerVisibleChange}
817+
onOpenChange={onTriggerVisibleChange}
818818
onPopupMouseEnter={onPopupMouseEnter}
819819
>
820820
{customizeRawInputElement ? (

src/SelectTrigger.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export interface SelectTriggerProps {
7474
empty: boolean;
7575

7676
getTriggerDOMNode: (node: HTMLElement) => HTMLElement;
77-
onPopupVisibleChange?: (visible: boolean) => void;
77+
onOpenChange?: (visible: boolean) => void;
7878

7979
onPopupMouseEnter: () => void;
8080
}
@@ -102,7 +102,7 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
102102
getPopupContainer,
103103
empty,
104104
getTriggerDOMNode,
105-
onPopupVisibleChange,
105+
onOpenChange,
106106
onPopupMouseEnter,
107107
...restProps
108108
} = props;
@@ -158,8 +158,8 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
158158
return (
159159
<Trigger
160160
{...restProps}
161-
showAction={onPopupVisibleChange ? ['click'] : []}
162-
hideAction={onPopupVisibleChange ? ['click'] : []}
161+
showAction={onOpenChange ? ['click'] : []}
162+
hideAction={onOpenChange ? ['click'] : []}
163163
popupPlacement={placement || (direction === 'rtl' ? 'bottomRight' : 'bottomLeft')}
164164
builtinPlacements={mergedBuiltinPlacements}
165165
prefixCls={popupPrefixCls}
@@ -175,7 +175,7 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
175175
})}
176176
popupStyle={mergedPopupStyle}
177177
getTriggerDOMNode={getTriggerDOMNode}
178-
onPopupVisibleChange={onPopupVisibleChange}
178+
onOpenChange={onOpenChange}
179179
>
180180
{children}
181181
</Trigger>

tests/Combobox.test.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -455,16 +455,16 @@ describe('Select.Combobox', () => {
455455
// https://github.com/ant-design/ant-design/issues/16572
456456
it('close when enter press without active option', () => {
457457
jest.useFakeTimers();
458-
const onPopupVisibleChange = jest.fn();
458+
const onOpenChange = jest.fn();
459459
const { container } = render(
460-
<Select mode="combobox" open onPopupVisibleChange={onPopupVisibleChange}>
460+
<Select mode="combobox" open onOpenChange={onOpenChange}>
461461
<Option value="One">One</Option>
462462
<Option value="Two">Two</Option>
463463
</Select>,
464464
);
465465
keyDown(container.querySelector('input')!, KeyCode.ENTER);
466466
jest.runAllTimers();
467-
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
467+
expect(onOpenChange).toHaveBeenCalledWith(false);
468468
jest.useRealTimers();
469469
});
470470

tests/Custom.test.tsx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,12 @@ describe('Select.Custom', () => {
1515
});
1616

1717
it('getRawInputElement', () => {
18-
const onPopupVisibleChange = jest.fn();
18+
const onOpenChange = jest.fn();
1919
const { container } = render(
20-
<Select
21-
getRawInputElement={() => <span className="custom" />}
22-
onPopupVisibleChange={onPopupVisibleChange}
23-
/>,
20+
<Select getRawInputElement={() => <span className="custom" />} onOpenChange={onOpenChange} />,
2421
);
2522
fireEvent.click(container.querySelector('.custom'));
2623

27-
expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
24+
expect(onOpenChange).toHaveBeenCalledWith(true);
2825
});
2926
});

tests/Popup.test.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ describe('Select.Popup', () => {
1313
injectRunAllTimers(jest);
1414

1515
it('click popup should not trigger close', () => {
16-
const onPopupVisibleChange = jest.fn();
16+
const onOpenChange = jest.fn();
1717
render(
1818
<Select
1919
open
2020
options={[{ value: 'bamboo' }]}
21-
onPopupVisibleChange={onPopupVisibleChange}
21+
onOpenChange={onOpenChange}
2222
getPopupContainer={() => document.body}
2323
/>,
2424
);
2525

2626
fireEvent.mouseDown(document.querySelector('.rc-select-dropdown'));
27-
expect(onPopupVisibleChange).not.toHaveBeenCalled();
27+
expect(onOpenChange).not.toHaveBeenCalled();
2828
});
2929
});

tests/Select.test.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -894,13 +894,13 @@ describe('Select.Basic', () => {
894894
open: true,
895895
};
896896

897-
public onPopupVisibleChange = (open) => {
897+
public onOpenChange = (open) => {
898898
this.setState({ open });
899899
};
900900

901901
public render() {
902902
return (
903-
<Select open={this.state.open} onPopupVisibleChange={this.onPopupVisibleChange}>
903+
<Select open={this.state.open} onOpenChange={this.onOpenChange}>
904904
<Option value="1">1</Option>
905905
</Select>
906906
);

0 commit comments

Comments
 (0)