Skip to content

fix(Popper): prevented forceUpdate from firing when not necessary #9088

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
May 15, 2023
Merged

fix(Popper): prevented forceUpdate from firing when not necessary #9088

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
30 changes: 22 additions & 8 deletions packages/react-core/src/helpers/Popper/Popper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
const [triggerElement, setTriggerElement] = React.useState(null);
const [refElement, setRefElement] = React.useState<HTMLElement>(null);
const [popperElement, setPopperElement] = React.useState<HTMLElement>(null);
const [popperContent, setPopperContent] = React.useState(null);
const [ready, setReady] = React.useState(false);
const refOrTrigger = refElement || triggerElement;
const onDocumentClickCallback = React.useCallback(
Expand Down Expand Up @@ -210,6 +211,18 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
}
}
}, [isVisible, popperRef]);
React.useEffect(() => {
// Trigger a Popper update when content changes.
const observer = new MutationObserver(() => {
update && update();
});
popperElement && observer.observe(popperElement, { attributes: true, childList: true, subtree: true });

return () => {
observer.disconnect();
};
}, [popperElement]);

const addEventListener = (listener: any, element: Document | HTMLElement, event: string, capture = false) => {
if (listener && element) {
element.addEventListener(event, listener, { capture });
Expand All @@ -234,12 +247,6 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
onDocumentClick && addEventListener(onDocumentClickCallback, document, 'click', true);
addEventListener(onDocumentKeyDown, document, 'keydown', true);

// Trigger a Popper update when content changes.
const observer = new MutationObserver(() => {
update && update();
});
popperElement && observer.observe(popperElement, { attributes: true, childList: true, subtree: true });

return () => {
removeEventListener(onMouseEnter, refOrTrigger, 'mouseenter');
removeEventListener(onMouseLeave, refOrTrigger, 'mouseleave');
Expand All @@ -252,7 +259,6 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
removeEventListener(onPopperMouseLeave, popperElement, 'mouseleave');
onDocumentClick && removeEventListener(onDocumentClickCallback, document, 'click', true);
removeEventListener(onDocumentKeyDown, document, 'keydown', true);
observer.disconnect();
};
}, [
triggerElement,
Expand Down Expand Up @@ -359,8 +365,16 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
]
});

/** We want to forceUpdate only when a tooltip's content is dynamically updated.
* TODO: Investigate into 3rd party libraries for a less limited/specific solution
*/
React.useEffect(() => {
forceUpdate && forceUpdate();
const currentPopperContent = popper?.props?.children[1]?.props?.children;
setPopperContent(currentPopperContent);

if (currentPopperContent && popperContent && currentPopperContent !== popperContent) {
forceUpdate && forceUpdate();
}
}, [popper]);

// Returns the CSS modifier class in order to place the Popper's arrow properly
Expand Down