Skip to content

Commit 46f0421

Browse files
authored
refactor(Layout): use rc-util useId for Sider registration (#59772)
* refactor(Layout): use rc-util useId for Sider registration * fix: update
1 parent a10e4e0 commit 46f0421

3 files changed

Lines changed: 21 additions & 18 deletions

File tree

‎components/layout/Sider.tsx‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { useContext, useEffect, useRef, useState } from 'react';
33
import BarsOutlined from '@ant-design/icons/BarsOutlined';
44
import LeftOutlined from '@ant-design/icons/LeftOutlined';
55
import RightOutlined from '@ant-design/icons/RightOutlined';
6-
import { omit, useControlledState } from '@rc-component/util';
6+
import { omit, useControlledState, useId } from '@rc-component/util';
77
import { clsx } from 'clsx';
88

99
import { useMergeSemantic } from '../_util/hooks/useMergeSemantic';
@@ -73,14 +73,6 @@ export interface SiderState {
7373
below: boolean;
7474
}
7575

76-
const generateId = (() => {
77-
let i = 0;
78-
return (prefix = '') => {
79-
i += 1;
80-
return `${prefix}${i}`;
81-
};
82-
})();
83-
8476
const Sider = React.forwardRef<HTMLDivElement, SiderProps>((props, ref) => {
8577
const {
8678
prefixCls: customizePrefixCls,
@@ -103,6 +95,7 @@ const Sider = React.forwardRef<HTMLDivElement, SiderProps>((props, ref) => {
10395
...otherProps
10496
} = props;
10597
const { siderHook } = useContext(LayoutContext);
98+
const uniqueId = useId();
10699

107100
const [collapsed, setCollapsed] = useControlledState(defaultCollapsed, props.collapsed);
108101
const [below, setBelow] = useState(false);
@@ -169,10 +162,11 @@ const Sider = React.forwardRef<HTMLDivElement, SiderProps>((props, ref) => {
169162
}, [breakpoint]); // in order to accept dynamic 'breakpoint' property, we need to add 'breakpoint' into dependency array.
170163

171164
useEffect(() => {
172-
const uniqueId = generateId('ant-sider-');
173165
siderHook.addSider(uniqueId);
174-
return () => siderHook.removeSider(uniqueId);
175-
}, []);
166+
return () => {
167+
siderHook.removeSider(uniqueId);
168+
};
169+
}, [uniqueId, siderHook]);
176170

177171
const toggle = () => {
178172
handleSetCollapsed(!collapsed, 'clickTrigger');

‎components/layout/__tests__/index.test.tsx‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,19 @@ describe('Layout', () => {
3939
unmount();
4040
});
4141

42-
it('umount from multiple siders', async () => {
42+
it.each([
43+
[0, 1],
44+
[1, 0],
45+
])('keeps the sider layout until nested siders unmount in order %i, %i', (first, second) => {
4346
const App: React.FC = () => {
4447
const [hide1, setHide1] = useState(false);
4548
const [hide2, setHide2] = useState(false);
4649
return (
4750
<Layout>
48-
{hide1 ? null : <Sider>Sider</Sider>}
49-
{hide2 ? null : <Sider>Sider</Sider>}
51+
<div>
52+
{hide1 ? null : <Sider>Sider</Sider>}
53+
{hide2 ? null : <Sider>Sider</Sider>}
54+
</div>
5055
<Content>
5156
<button onClick={() => setHide1(true)} type="button">
5257
hide sider 1
@@ -62,11 +67,11 @@ describe('Layout', () => {
6267
expect(container.querySelector('.ant-layout')?.className.includes('ant-layout-has-sider')).toBe(
6368
true,
6469
);
65-
fireEvent.click(container.querySelectorAll('button')[0]);
70+
fireEvent.click(container.querySelectorAll<HTMLButtonElement>('button')[first]);
6671
expect(container.querySelector('.ant-layout')?.className.includes('ant-layout-has-sider')).toBe(
6772
true,
6873
);
69-
fireEvent.click(container.querySelectorAll('button')[1]);
74+
fireEvent.click(container.querySelectorAll<HTMLButtonElement>('button')[second]);
7075
expect(container.querySelector('.ant-layout')?.className.includes('ant-layout-has-sider')).toBe(
7176
false,
7277
);

‎components/layout/layout.tsx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,11 @@ const BasicLayout = React.forwardRef<HTMLDivElement, BasicPropsWithTagName>((pro
110110
setSiders((prev) => [...prev, id]);
111111
},
112112
removeSider: (id: string) => {
113-
setSiders((prev) => prev.filter((currentId) => currentId !== id));
113+
setSiders((prev) => {
114+
// Remove only one registration when multiple siders share an ID.
115+
const index = prev.indexOf(id);
116+
return prev.filter((_, currentIndex) => currentIndex !== index);
117+
});
114118
},
115119
},
116120
}),

0 commit comments

Comments
 (0)