Skip to content

refactor: rename onPopupVisibleChange to onOpenChange across components #1136

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.

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 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,5 @@ tsconfig.test.json
.dumi/tmp
.dumi/tmp-test
.dumi/tmp-production
.history
.history
pnpm-lock.yaml
4 changes: 2 additions & 2 deletions docs/examples/controlled.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class Controlled extends React.Component<{}, ControlledState> {
console.log('onFocus');
};

onPopupVisibleChange = (open) => {
onOpenChange = (open) => {
this.setState({ open });
};

Expand All @@ -68,7 +68,7 @@ class Controlled extends React.Component<{}, ControlledState> {
optionLabelProp="children"
optionFilterProp="text"
onChange={this.onChange}
onPopupVisibleChange={this.onPopupVisibleChange}
onOpenChange={this.onOpenChange}
>
<Option value="01" text="jack" title="jack">
<b
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@
"react-dom": "*"
},
"dependencies": {
"@rc-component/trigger": "^3.0.0",
"@rc-component/motion": "^1.1.4",
"@rc-component/trigger": "^3.0.0",
"@rc-component/util": "^1.2.1",
"classnames": "2.x",
"rc-overflow": "^1.4.0",
Expand All @@ -62,6 +62,7 @@
"@testing-library/jest-dom": "^6.4.5",
"@testing-library/react": "^15.0.6",
"@types/jest": "^29.5.12",
"@types/node": "^22.14.0",
"@types/react": "^18.3.0",
"@types/react-dom": "^18.3.0",
"babel-jest": "^29.6.1",
Expand Down
12 changes: 6 additions & 6 deletions src/BaseSelect/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export interface BaseSelectProps extends BaseSelectPrivateProps, React.AriaAttri
// >>> Open
open?: boolean;
defaultOpen?: boolean;
onPopupVisibleChange?: (open: boolean) => void;
onOpenChange?: (open: boolean) => void;

// >>> Customize Input
/** @private Internal usage. Do not use in your production. */
Expand Down Expand Up @@ -257,7 +257,7 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
// Open
open,
defaultOpen,
onPopupVisibleChange,
onOpenChange,

// Active
activeValue,
Expand Down Expand Up @@ -401,11 +401,11 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
setInnerOpen(nextOpen);

if (mergedOpen !== nextOpen) {
onPopupVisibleChange?.(nextOpen);
onOpenChange?.(nextOpen);
}
}
},
[disabled, mergedOpen, setInnerOpen, onPopupVisibleChange],
[disabled, mergedOpen, setInnerOpen, onOpenChange],
);

// ============================= Search =============================
Expand Down Expand Up @@ -794,7 +794,7 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
ref={triggerRef}
disabled={disabled}
prefixCls={prefixCls}
visible={triggerOpen}
open={triggerOpen}
popupElement={optionList}
animation={animation}
transitionName={transitionName}
Expand All @@ -814,7 +814,7 @@ const BaseSelect = React.forwardRef<BaseSelectRef, BaseSelectProps>((props, ref)
// But we should update `rc-resize-observer` first.
selectorDomRef.current || node
}
onPopupVisibleChange={onTriggerVisibleChange}
onOpenChange={onTriggerVisibleChange}
onPopupMouseEnter={onPopupMouseEnter}
>
{customizeRawInputElement ? (
Expand Down
16 changes: 8 additions & 8 deletions src/SelectTrigger.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface SelectTriggerProps {
prefixCls: string;
children: React.ReactElement;
disabled: boolean;
visible: boolean;
open: boolean;
popupElement: React.ReactElement;

animation?: string;
Expand All @@ -74,7 +74,7 @@ export interface SelectTriggerProps {
empty: boolean;

getTriggerDOMNode: (node: HTMLElement) => HTMLElement;
onPopupVisibleChange?: (visible: boolean) => void;
onOpenChange?: (open: boolean) => void;

onPopupMouseEnter: () => void;
}
Expand All @@ -86,7 +86,7 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
const {
prefixCls,
disabled,
visible,
open,
children,
popupElement,
animation,
Expand All @@ -102,7 +102,7 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
getPopupContainer,
empty,
getTriggerDOMNode,
onPopupVisibleChange,
onOpenChange,
onPopupMouseEnter,
...restProps
} = props;
Expand Down Expand Up @@ -158,8 +158,8 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
return (
<Trigger
{...restProps}
showAction={onPopupVisibleChange ? ['click'] : []}
hideAction={onPopupVisibleChange ? ['click'] : []}
showAction={onOpenChange ? ['click'] : []}
hideAction={onOpenChange ? ['click'] : []}
popupPlacement={placement || (direction === 'rtl' ? 'bottomRight' : 'bottomLeft')}
builtinPlacements={mergedBuiltinPlacements}
prefixCls={popupPrefixCls}
Expand All @@ -168,14 +168,14 @@ const SelectTrigger: React.ForwardRefRenderFunction<RefTriggerProps, SelectTrigg
ref={triggerPopupRef}
stretch={stretch}
popupAlign={popupAlign}
popupVisible={visible}
popupVisible={open}
getPopupContainer={getPopupContainer}
popupClassName={classNames(popupClassName, {
[`${popupPrefixCls}-empty`]: empty,
})}
popupStyle={mergedPopupStyle}
getTriggerDOMNode={getTriggerDOMNode}
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
>
{children}
</Trigger>
Expand Down
6 changes: 3 additions & 3 deletions tests/Combobox.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -455,16 +455,16 @@ describe('Select.Combobox', () => {
// https://github.com/ant-design/ant-design/issues/16572
it('close when enter press without active option', () => {
jest.useFakeTimers();
const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();
const { container } = render(
<Select mode="combobox" open onPopupVisibleChange={onPopupVisibleChange}>
<Select mode="combobox" open onOpenChange={onOpenChange}>
<Option value="One">One</Option>
<Option value="Two">Two</Option>
</Select>,
);
keyDown(container.querySelector('input')!, KeyCode.ENTER);
jest.runAllTimers();
expect(onPopupVisibleChange).toHaveBeenCalledWith(false);
expect(onOpenChange).toHaveBeenCalledWith(false);
jest.useRealTimers();
});

Expand Down
9 changes: 3 additions & 6 deletions tests/Custom.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,12 @@ describe('Select.Custom', () => {
});

it('getRawInputElement', () => {
const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();
const { container } = render(
<Select
getRawInputElement={() => <span className="custom" />}
onPopupVisibleChange={onPopupVisibleChange}
/>,
<Select getRawInputElement={() => <span className="custom" />} onOpenChange={onOpenChange} />,
);
fireEvent.click(container.querySelector('.custom'));

expect(onPopupVisibleChange).toHaveBeenCalledWith(true);
expect(onOpenChange).toHaveBeenCalledWith(true);
});
});
6 changes: 3 additions & 3 deletions tests/Popup.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ describe('Select.Popup', () => {
injectRunAllTimers(jest);

it('click popup should not trigger close', () => {
const onPopupVisibleChange = jest.fn();
const onOpenChange = jest.fn();
render(
<Select
open
options={[{ value: 'bamboo' }]}
onPopupVisibleChange={onPopupVisibleChange}
onOpenChange={onOpenChange}
getPopupContainer={() => document.body}
/>,
);

fireEvent.mouseDown(document.querySelector('.rc-select-dropdown'));
expect(onPopupVisibleChange).not.toHaveBeenCalled();
expect(onOpenChange).not.toHaveBeenCalled();
});
});
4 changes: 2 additions & 2 deletions tests/Select.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -894,13 +894,13 @@ describe('Select.Basic', () => {
open: true,
};

public onPopupVisibleChange = (open) => {
public onOpenChange = (open) => {
this.setState({ open });
};

public render() {
return (
<Select open={this.state.open} onPopupVisibleChange={this.onPopupVisibleChange}>
<Select open={this.state.open} onOpenChange={this.onOpenChange}>
<Option value="1">1</Option>
</Select>
);
Expand Down
Loading