Skip to content

fix(Popper): update Popper modifiers when child DOM changes #7385

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
tlabaj merged 4 commits into from
May 9, 2022
Merged

fix(Popper): update Popper modifiers when child DOM changes #7385

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15dc8ef
fix(Popper): update Popper modifiers when child DOM changes
nicolethoen May 6, 2022
4e139ef
update comments
nicolethoen May 6, 2022
039a26a
fix build error
nicolethoen May 6, 2022
e522065
udpate comment
nicolethoen May 9, 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
17 changes: 10 additions & 7 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 @@ -165,6 +165,7 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
element.removeEventListener(event, listener);
}
};

React.useEffect(() => {
addEventListener(onMouseEnter, refOrTrigger, 'mouseenter');
addEventListener(onMouseLeave, refOrTrigger, 'mouseleave');
Expand All @@ -175,6 +176,13 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
addEventListener(onPopperClick, popperElement, 'click');
onDocumentClick && addEventListener(onDocumentClickCallback, document, 'click');
addEventListener(onDocumentKeyDown, document, 'keydown');

// 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 @@ -185,6 +193,7 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
removeEventListener(onPopperClick, popperElement, 'click');
onDocumentClick && removeEventListener(onDocumentClickCallback, document, 'click');
removeEventListener(onDocumentKeyDown, document, 'keydown');
observer.disconnect();
};
}, [
triggerElement,
Expand Down Expand Up @@ -233,7 +242,7 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
[popperMatchesTriggerWidth]
);

const { styles: popperStyles, attributes, forceUpdate } = usePopper(refOrTrigger, popperElement, {
const { styles: popperStyles, attributes, update } = usePopper(refOrTrigger, popperElement, {
placement: getPlacementMemo,
modifiers: [
{
Expand Down Expand Up @@ -262,12 +271,6 @@ export const Popper: React.FunctionComponent<PopperProps> = ({
]
});

// force update when content changes
// https://github.com/patternfly/patternfly-react/issues/5620
React.useEffect(() => {
forceUpdate && forceUpdate();
}, [popper]);

// Returns the CSS modifier class in order to place the Popper's arrow properly
// Depends on the position of the Popper relative to the reference element
const modifierFromPopperPosition = () => {
Expand Down