Skip to content

refactor: deprecate some api and add test case #581

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
Apr 1, 2025
Merged

refactor: deprecate some api and add test case #581

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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ lib
es
yarn.lock
package-lock.json
pnpm-lock.yaml
coverage
# umi
.umi
Expand Down
6 changes: 5 additions & 1 deletion src/Cascader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,11 @@ interface BaseCascaderProps<
placement?: Placement;
builtinPlacements?: BuildInPlacements;

/** @deprecated Use `onDropdownVisibleChange` instead */
/** @deprecated Use `onOpenChange` instead */
onPopupVisibleChange?: (open: boolean) => void;
/** @deprecated Use `onOpenChange` instead */
onDropdownVisibleChange?: (open: boolean) => void;
onOpenChange?: (open: boolean) => void;

// Icon
expandIcon?: React.ReactNode;
Expand Down Expand Up @@ -227,6 +229,7 @@ const Cascader = React.forwardRef<CascaderRef, InternalCascaderProps>((props, re

onDropdownVisibleChange,
onPopupVisibleChange,
onOpenChange,

// Icon
expandIcon = '>',
Expand Down Expand Up @@ -384,6 +387,7 @@ const Cascader = React.forwardRef<CascaderRef, InternalCascaderProps>((props, re
const mergedPlacement = placement || popupPlacement;

const onInternalDropdownVisibleChange = (nextVisible: boolean) => {
onOpenChange?.(nextVisible)
onDropdownVisibleChange?.(nextVisible);
onPopupVisibleChange?.(nextVisible);
};
Expand Down
8 changes: 6 additions & 2 deletions src/utils/warningPropsUtil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@ import warning from 'rc-util/lib/warning';
import type { DefaultOptionType, FieldNames, InternalCascaderProps } from '../Cascader';

function warningProps(props: InternalCascaderProps) {
const { onPopupVisibleChange, popupVisible, popupClassName, popupPlacement } = props;
const { onPopupVisibleChange, popupVisible, popupClassName, popupPlacement, onDropdownVisibleChange } = props;

warning(
!onPopupVisibleChange,
'`onPopupVisibleChange` is deprecated. Please use `onDropdownVisibleChange` instead.',
'`onPopupVisibleChange` is deprecated. Please use `onOpenChange` instead.',
);
warning(
!onDropdownVisibleChange,
'`onDropdownVisibleChange` is deprecated. Please use `onOpenChange` instead.',
);
warning(popupVisible === undefined, '`popupVisible` is deprecated. Please use `open` instead.');
warning(
Expand Down
9 changes: 7 additions & 2 deletions tests/index.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,21 +514,26 @@ describe('Cascader.Basic', () => {
expect(wrapper.isOpen()).toBeTruthy();
});

it('warning popupVisible & onPopupVisibleChange & popupClassName', () => {
it('warning popupVisible & onPopupVisibleChange & onDropdownVisibleChange & popupClassName & popupPlacement', () => {
resetWarned();
const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
const onPopupVisibleChange = jest.fn();
const onDropdownVisibleChange = jest.fn();
const wrapper = mount(
<Cascader
popupVisible
onPopupVisibleChange={onPopupVisibleChange}
onDropdownVisibleChange={onDropdownVisibleChange}
popupClassName="legacy-cls"
popupPlacement="topRight"
/>,
);

expect(errorSpy).toHaveBeenCalledWith(
'Warning: `onPopupVisibleChange` is deprecated. Please use `onDropdownVisibleChange` instead.',
'Warning: `onPopupVisibleChange` is deprecated. Please use `onOpenChange` instead.',
);
expect(errorSpy).toHaveBeenCalledWith(
'Warning: `onDropdownVisibleChange` is deprecated. Please use `onOpenChange` instead.',
);
expect(errorSpy).toHaveBeenCalledWith(
'Warning: `popupVisible` is deprecated. Please use `open` instead.',
Expand Down