Skip to content

fix: Popover is positioned incorrectly when the layout changes #3427

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 1 commit into
base: main
Choose a base branch
from
Open
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
20 changes: 14 additions & 6 deletions src/popover/container.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@
/*
This is a heuristic. Some layout changes are caused by user clicks (e.g. toggling the tools panel, submitting a form),
and by tracking the click event we can adapt the popover's position to the new layout.

TODO: extend this to Enter and Spacebar?
*/

const onClick = (event: UIEvent | KeyboardEvent) => {
const controller = new AbortController();

const onClick = async (event: UIEvent | KeyboardEvent) => {
if (
// Do not update position if keepPosition is true.
keepPosition ||
Expand All @@ -114,14 +114,22 @@
return;
}

requestAnimationFrame(() => {
// Continuously update the popover position for one second to account for any layout changes
// and animations. This runs only while the CPU is otherwise idle.
const targetTime = performance.now() + 1_000;

while (performance.now() < targetTime) {
if (controller.signal.aborted) {
break;
}

updatePositionHandler();
});
await new Promise(r => requestIdleCallback(r));

Check failure on line 127 in src/popover/container.tsx

View workflow job for this annotation

GitHub Actions / build / build

ARIA labels › accessibility validation basic popover

ReferenceError: requestIdleCallback is not defined at src/popover/container.tsx:127:32 at src/popover/container.tsx:127:15 at node_modules/tslib/tslib.js:169:75 at __awaiter (node_modules/tslib/tslib.js:165:16) at onClick (src/popover/container.tsx:106:62) at callTheUserObjectsOperation (node_modules/jsdom/lib/jsdom/living/generated/EventListener.js:26:30) at innerInvokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:350:25) at invokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:286:3) at HTMLButtonElementImpl._dispatch (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:233:9) at HTMLButtonElementImpl.dispatchEvent (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:104:17) at HTMLButtonElement.dispatchEvent (node_modules/jsdom/lib/jsdom/living/generated/EventTarget.js:241:34) at dispatchEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:69:27) at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at ButtonWrapper.AbstractWrapper.fireEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:68:28) at ButtonWrapper.fireEvent [as click] (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:52:14) at src/popover/__tests__/popover.test.tsx:193:36 at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at Object.<anonymous> (src/popover/__tests__/popover.test.tsx:192:8)

Check failure on line 127 in src/popover/container.tsx

View workflow job for this annotation

GitHub Actions / build / build

ARIA labels › accessibility validation basic popover

ReferenceError: requestIdleCallback is not defined at src/popover/container.tsx:127:32 at src/popover/container.tsx:127:15 at node_modules/tslib/tslib.js:169:75 at __awaiter (node_modules/tslib/tslib.js:165:16) at onClick (src/popover/container.tsx:106:62) at callTheUserObjectsOperation (node_modules/jsdom/lib/jsdom/living/generated/EventListener.js:26:30) at innerInvokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:350:25) at invokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:286:3) at HTMLButtonElementImpl._dispatch (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:233:9) at HTMLButtonElementImpl.dispatchEvent (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:104:17) at HTMLButtonElement.dispatchEvent (node_modules/jsdom/lib/jsdom/living/generated/EventTarget.js:241:34) at dispatchEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:69:27) at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at ButtonWrapper.AbstractWrapper.fireEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:68:28) at ButtonWrapper.fireEvent [as click] (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:52:14) at src/popover/__tests__/popover.test.tsx:182:36 at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at Object.<anonymous> (src/popover/__tests__/popover.test.tsx:181:8)

Check failure on line 127 in src/popover/container.tsx

View workflow job for this annotation

GitHub Actions / dry-run / Components unit tests

ARIA labels › accessibility validation basic popover

ReferenceError: requestIdleCallback is not defined at src/popover/container.tsx:127:32 at src/popover/container.tsx:127:15 at node_modules/tslib/tslib.js:169:75 at __awaiter (node_modules/tslib/tslib.js:165:16) at onClick (src/popover/container.tsx:106:62) at callTheUserObjectsOperation (node_modules/jsdom/lib/jsdom/living/generated/EventListener.js:26:30) at innerInvokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:350:25) at invokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:286:3) at HTMLButtonElementImpl._dispatch (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:233:9) at HTMLButtonElementImpl.dispatchEvent (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:104:17) at HTMLButtonElement.dispatchEvent (node_modules/jsdom/lib/jsdom/living/generated/EventTarget.js:241:34) at dispatchEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:69:27) at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at ButtonWrapper.AbstractWrapper.fireEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:68:28) at ButtonWrapper.fireEvent [as click] (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:52:14) at src/popover/__tests__/popover.test.tsx:193:36 at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at Object.<anonymous> (src/popover/__tests__/popover.test.tsx:192:8)

Check failure on line 127 in src/popover/container.tsx

View workflow job for this annotation

GitHub Actions / dry-run / Components unit tests

ARIA labels › accessibility validation basic popover

ReferenceError: requestIdleCallback is not defined at src/popover/container.tsx:127:32 at src/popover/container.tsx:127:15 at node_modules/tslib/tslib.js:169:75 at __awaiter (node_modules/tslib/tslib.js:165:16) at onClick (src/popover/container.tsx:106:62) at callTheUserObjectsOperation (node_modules/jsdom/lib/jsdom/living/generated/EventListener.js:26:30) at innerInvokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:350:25) at invokeEventListeners (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:286:3) at HTMLButtonElementImpl._dispatch (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:233:9) at HTMLButtonElementImpl.dispatchEvent (node_modules/jsdom/lib/jsdom/living/events/EventTarget-impl.js:104:17) at HTMLButtonElement.dispatchEvent (node_modules/jsdom/lib/jsdom/living/generated/EventTarget.js:241:34) at dispatchEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:69:27) at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at ButtonWrapper.AbstractWrapper.fireEvent (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:68:28) at ButtonWrapper.fireEvent [as click] (node_modules/@cloudscape-design/test-utils-core/dist/dom.js:52:14) at src/popover/__tests__/popover.test.tsx:182:36 at batchedUpdates$1 (node_modules/react-dom/cjs/react-dom.development.js:21856:12) at act (node_modules/react-dom/cjs/react-dom-test-utils.development.js:929:14) at Object.<anonymous> (src/popover/__tests__/popover.test.tsx:181:8)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if having an extra micro-task here is necessary. It took me some time to understand what's happening.

The way I read this is that: we create a micro-task, wait for a free cycle and then resolve the promise. This means the calculation doesn't happen in the cpu's free time, we just wait for a free CPU time to run the next cycle.

A simpler approach IMO would be simply having animation pattern:

function updatePosition() {
  if (controller.signal.aborted) return;
  if (performance.now() >= targetTime) return;
  
  updatePositionHandler();
  requestIdleCallback(updatePosition);
}

requestIdleCallback(updatePosition);

}
};

const updatePositionOnResize = () => requestAnimationFrame(() => updatePositionHandler());
const refreshPosition = () => requestAnimationFrame(() => positionHandlerRef.current());
const controller = new AbortController();

window.addEventListener('click', onClick, { signal: controller.signal });
window.addEventListener('resize', updatePositionOnResize, { signal: controller.signal });
Expand Down
Loading