Skip to content

Wrap toggleScrollListener calls in requestAnimationFrame callback to prevent forced style recalculations #25328

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

Closed
chenxinyanc wants to merge 2 commits into from
Closed

Wrap toggleScrollListener calls in requestAnimationFrame callback to prevent forced style recalculations #25328

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
ec3d3ec
Wrap toggleScrollListener inside RAF calls.
chenxinyanc Oct 21, 2022
985b06b
Change file.
chenxinyanc Oct 21, 2022
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-positioning-49f77ad4-3265-436c-b6b1-51312f5591ae.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Wrap toggleScrollListener calls in requestAnimationFrame callback.",
"packageName": "@fluentui/react-positioning",
"email": "[email protected]",
"dependentChangeType": "patch"
}
16 changes: 10 additions & 6 deletions packages/react-components/react-positioning/src/usePositioning.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,17 +267,21 @@ function useContainerRef(updatePosition: () => void, enabled: boolean) {
Object.assign(container.style, { position: 'fixed', left: 0, top: 0, margin: 0 });
}

toggleScrollListener(container, prevContainer, updatePosition);

updatePosition();
// toggleScrollListener requires computed styles; thus use RAF to prevent forced style reevaluation.
window.requestAnimationFrame(() => {
Copy link
Member

@layershifter layershifter Oct 31, 2022

Choose a reason for hiding this comment

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

We need to use a proper window instance, otherwise requestAnimationFrame may not be triggered properly.

You can get it from useFluent() (it's already used in this component):

const { targetDocument } = useFluent();

targetDocument?.defaultView?.requestAnimationFrame()

toggleScrollListener(container, prevContainer, updatePosition);
updatePosition();
});
});
}

function useTargetRef(updatePosition: () => void) {
return useCallbackRef<HTMLElement | PositioningVirtualElement | null>(null, (target, prevTarget) => {
toggleScrollListener(target, prevTarget, updatePosition);

updatePosition();
// toggleScrollListener requires computed styles; thus use RAF to prevent forced style reevaluation.
window.requestAnimationFrame(() => {
Copy link
Member

@layershifter layershifter Oct 31, 2022

Choose a reason for hiding this comment

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

All requestAnimationFrame() calls should be cleaned up on a component to avoid reference/memory leaks or throwing exceptions. Typically it's:

const requestRef = React.useRef();

// ---
requestRef.current = requestAnimationFrame();
// ---

React.useEffect(() => {
  return () => {
    cancelAnimationFrame(requestRef.current);
  };
}, []);

toggleScrollListener(target, prevTarget, updatePosition);
updatePosition();
});
});
}

Expand Down