Skip to content

perf: not render popup on init #554

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

Open
wants to merge 2 commits into
base: antd-v5
Choose a base branch
from
+157 −49
Open

perf: not render popup on init #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
629b923
perf: not render popup on init
gavanx Jul 13, 2025
910028c
tests: perf not render init
gavanx Jul 19, 2025
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
104 changes: 55 additions & 49 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,10 @@ export function generateTrigger(
cloneProps.className = classNames(originChildProps.className, className);
}

// ============================ Perf ============================
const renderedRef = React.useRef(false);
renderedRef.current ||= forceRender || mergedOpen || inMotion;

// =========================== Render ===========================
const mergedChildrenProps = {
...originChildProps,
Expand Down Expand Up @@ -702,55 +706,57 @@ export function generateTrigger(
{triggerNode}
</TriggerWrapper>
</ResizeObserver>
<TriggerContext.Provider value={context}>
<Popup
portal={PortalComponent}
ref={setPopupRef}
prefixCls={prefixCls}
popup={popup}
className={classNames(popupClassName, alignedClassName)}
style={popupStyle}
target={targetEle}
onMouseEnter={onPopupMouseEnter}
onMouseLeave={onPopupMouseLeave}
// https://github.com/ant-design/ant-design/issues/43924
onPointerEnter={onPopupMouseEnter}
zIndex={zIndex}
// Open
open={mergedOpen}
keepDom={inMotion}
fresh={fresh}
// Click
onClick={onPopupClick}
onPointerDownCapture={onPopupPointerDown}
// Mask
mask={mask}
// Motion
motion={mergePopupMotion}
maskMotion={mergeMaskMotion}
onVisibleChanged={onVisibleChanged}
onPrepare={onPrepare}
// Portal
forceRender={forceRender}
autoDestroy={mergedAutoDestroy}
getPopupContainer={getPopupContainer}
// Arrow
align={alignInfo}
arrow={innerArrow}
arrowPos={arrowPos}
// Align
ready={ready}
offsetX={offsetX}
offsetY={offsetY}
offsetR={offsetR}
offsetB={offsetB}
onAlign={triggerAlign}
// Stretch
stretch={stretch}
targetWidth={targetWidth / scaleX}
targetHeight={targetHeight / scaleY}
/>
</TriggerContext.Provider>
{renderedRef.current && (
<TriggerContext.Provider value={context}>
<Popup
portal={PortalComponent}
ref={setPopupRef}
prefixCls={prefixCls}
popup={popup}
className={classNames(popupClassName, alignedClassName)}
style={popupStyle}
target={targetEle}
onMouseEnter={onPopupMouseEnter}
onMouseLeave={onPopupMouseLeave}
// https://github.com/ant-design/ant-design/issues/43924
onPointerEnter={onPopupMouseEnter}
zIndex={zIndex}
// Open
open={mergedOpen}
keepDom={inMotion}
fresh={fresh}
// Click
onClick={onPopupClick}
onPointerDownCapture={onPopupPointerDown}
// Mask
mask={mask}
// Motion
motion={mergePopupMotion}
maskMotion={mergeMaskMotion}
onVisibleChanged={onVisibleChanged}
onPrepare={onPrepare}
// Portal
forceRender={forceRender}
autoDestroy={mergedAutoDestroy}
getPopupContainer={getPopupContainer}
// Arrow
align={alignInfo}
arrow={innerArrow}
arrowPos={arrowPos}
// Align
ready={ready}
offsetX={offsetX}
offsetY={offsetY}
offsetR={offsetR}
offsetB={offsetB}
onAlign={triggerAlign}
// Stretch
stretch={stretch}
targetWidth={targetWidth / scaleX}
targetHeight={targetHeight / scaleY}
/>
</TriggerContext.Provider>
)}
</>
);
});
Expand Down
102 changes: 102 additions & 0 deletions tests/perf.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
import { cleanup, fireEvent, render } from '@testing-library/react';
import { spyElementPrototypes } from 'rc-util/lib/test/domHook';
import React from 'react';
import Trigger, { type TriggerProps } from '../src';
import { awaitFakeTimer, placementAlignMap } from './util';

jest.mock('../src/Popup', () => {
const OriReact = jest.requireActual('react');
const OriPopup = jest.requireActual('../src/Popup').default;

return OriReact.forwardRef((props, ref) => {
global.popupCalledTimes = (global.popupCalledTimes || 0) + 1;
return <OriPopup {...props} ref={ref} />;
});
});

describe('Trigger.Basic', () => {
beforeAll(() => {
spyElementPrototypes(HTMLElement, {
offsetParent: {
get: () => document.body,
},
});
});

beforeEach(() => {
global.popupCalledTimes = 0;
jest.useFakeTimers();
});

afterEach(() => {
cleanup();
jest.useRealTimers();
});

async function trigger(dom: HTMLElement, selector: string, method = 'click') {
fireEvent[method](dom.querySelector(selector));
await awaitFakeTimer();
}

const renderTrigger = (props?: Partial<TriggerProps>) => (
<Trigger
action={['click']}
popupAlign={placementAlignMap.left}
popup={<strong className="x-content">tooltip2</strong>}
{...props}
>
<div className="target">click</div>
</Trigger>
);

describe('Performance', () => {
it('not create Popup when !open', async () => {
const { container } = render(renderTrigger());

// Not render Popup
await awaitFakeTimer();
expect(global.popupCalledTimes).toBe(0);

// Now can render Popup
await trigger(container, '.target');
expect(global.popupCalledTimes).toBeGreaterThan(0);

expect(document.querySelector('.rc-trigger-popup')).toBeTruthy();
});

it('forceRender should create when !open', async () => {
const { container } = render(
renderTrigger({
forceRender: true,
}),
);

await awaitFakeTimer();
await trigger(container, '.target');
expect(global.popupCalledTimes).toBeGreaterThan(0);

expect(document.querySelector('.rc-trigger-popup')).toBeTruthy();
});

it('hide should keep render Popup', async () => {
const { rerender } = render(
renderTrigger({
popupVisible: true,
}),
);

await awaitFakeTimer();
expect(global.popupCalledTimes).toBeGreaterThan(0);

// Hide
global.popupCalledTimes = 0;
rerender(
renderTrigger({
popupVisible: false,
}),
);
await awaitFakeTimer();
expect(global.popupCalledTimes).toBeGreaterThan(0);
});
});
});