Skip to content
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

Fix: Chat - Link in end of line displays tooltip over text and not on link #27817

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 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
6 changes: 6 additions & 0 deletions src/components/Hoverable/hoverablePropTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ const propTypes = {
/** Function that executes when the mouse leaves the children. */
onHoverOut: PropTypes.func,

/** Direct pass-through of React's onMouseEnter event. */
onMouseEnter: PropTypes.func,

/** Direct pass-through of React's onMouseLeave event. */
onMouseLeave: PropTypes.func,

/** Decides whether to handle the scroll behaviour to show hover once the scroll ends */
shouldHandleScroll: PropTypes.bool,
};
Expand Down
6 changes: 6 additions & 0 deletions src/components/Hoverable/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -159,13 +159,19 @@ class Hoverable extends Component {
if (_.isFunction(child.props.onMouseEnter)) {
child.props.onMouseEnter(el);
}
if (_.isFunction(this.props.onMouseEnter)) {
this.props.onMouseEnter(el);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Move this to be the first callback (same for onMouseLeave)

Copy link
Author

Choose a reason for hiding this comment

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

Done.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is still not the first, it needs to goes before setIsHovered

Copy link
Author

Choose a reason for hiding this comment

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

Done.

},
onMouseLeave: (el) => {
this.setIsHovered(false);

if (_.isFunction(child.props.onMouseLeave)) {
child.props.onMouseLeave(el);
}
if (_.isFunction(this.props.onMouseLeave)) {
this.props.onMouseLeave(el);
}
},
onBlur: (el) => {
// Check if the blur event occurred due to clicking outside the element
Expand Down
79 changes: 75 additions & 4 deletions src/components/Tooltip/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,63 @@ import useWindowDimensions from '../../hooks/useWindowDimensions';

const hasHoverSupport = DeviceCapabilities.hasHoverSupport();

/**
* Choose the correct bounding box from the given list.
* This is a helper function for chooseBoundingBox below.
*
* @param {Element} bbs The bounding boxes of DOM element being hovered over.
* @param {number} clientX The X position from the MouseEvent.
* @param {number} clientY The Y position from the MouseEvent.
* @param {number} slop An allowed slop factor when searching for the bounding
* box. If the user is moving the mouse quickly we can end up getting a
* hover event with the position outside any of our bounding boxes. We retry
* with a small slop factor in that case, so if we have a bounding box close
* enough then we go with that.
Comment on lines +23 to +27
Copy link
Contributor

Choose a reason for hiding this comment

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

I have been checking and I think the need for the tolerance is not related to moving the mouse quickly, I can reproduce the bug constantly and this seems due to the returned bbs values corresponding to the text fragments only and not the block. Let's have the tolerance always used and integrate this function inside chooseBoundingBox

* @return {DOMRect | null} The chosen bounding box. null if we failed to find
* a matching one, which can happen if the user is moving the mouse quickly
* and the onHoverOver event actually fires outside the element bounding box.
*/
function chooseBoundingBoxWithSlop(bbs, clientX, clientY, slop) {
for (let i = 0; i < bbs.length; i++) {
const bb = bbs[i];
if (bb.x - slop <= clientX && bb.x + bb.width + slop >= clientX && bb.y - slop <= clientY && bb.y + bb.height + slop >= clientY) {
return bb;
}
}
return null;
}

/**
* Choose the correct bounding box for the tooltip to be positioned against.
* This handles the case where the target is wrapped across two lines, and
* so we need to find the correct part (the one that the user is hovering
* over) and show the tooltip there.
*
* @param {Element} target The DOM element being hovered over.
* @param {number} clientX The X position from the MouseEvent.
* @param {number} clientY The Y position from the MouseEvent.
* @return {DOMRect} The chosen bounding box.
*/
function chooseBoundingBox(target, clientX, clientY) {
const bbs = target.getClientRects();
if (bbs.length === 1) {
return bbs[0];
}
let bb = chooseBoundingBoxWithSlop(bbs, clientX, clientY, 0);
if (bb) {
return bb;
}
// Retry with a slop factor, in case the user is moving the mouse quickly.
bb = chooseBoundingBoxWithSlop(bbs, clientX, clientY, 5);
if (bb) {
return bb;
}
// Fall back to the full bounding box if we failed to find a matching one.
// This could only happen if the user is moving the mouse very quickly
// and they got it outside our slop above.
return target.getBoundingClientRect();
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
return target.getBoundingClientRect();
return bbs[0];

}

/**
* A component used to wrap an element intended for displaying a tooltip. The term "tooltip's target" refers to the
* wrapped element, which, upon hover, triggers the tooltip to be shown.
Expand Down Expand Up @@ -43,6 +100,14 @@ function Tooltip(props) {
const isAnimationCanceled = useRef(false);
const prevText = usePrevious(text);

const target = useRef(null);
const initialMousePosition = useRef({x: 0, y: 0});

const updateTargetAndMousePosition = useCallback((e) => {
target.current = e.target;
initialMousePosition.current = {x: e.clientX, y: e.clientY};
}, []);

/**
* Display the tooltip in an animation.
*/
Expand Down Expand Up @@ -91,10 +156,15 @@ function Tooltip(props) {
if (bounds.width === 0) {
setIsRendered(false);
}
setWrapperWidth(bounds.width);
setWrapperHeight(bounds.height);
setXOffset(bounds.x);
setYOffset(bounds.y);
const t = target.current;
if (!t) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a case where target is not defined?

Copy link
Author

Choose a reason for hiding this comment

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

No, but the type system would not be able to see that, because it cannot tell that updateBounds will never be called before a hover event makes the tooltip visible.

Regardless, this file is not TypeScript, so I've removed it.

const betterBounds = chooseBoundingBox(t, initialMousePosition.current.x, initialMousePosition.current.y);
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a comment here on why we need better bounding box

Copy link
Author

Choose a reason for hiding this comment

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

Done.

setWrapperWidth(betterBounds.width);
setWrapperHeight(betterBounds.height);
setXOffset(betterBounds.x);
setYOffset(betterBounds.y);
};

/**
Expand Down Expand Up @@ -152,6 +222,7 @@ function Tooltip(props) {
onBoundsChange={updateBounds}
>
<Hoverable
onMouseEnter={updateTargetAndMousePosition}
onHoverIn={showTooltip}
onHoverOut={hideTooltip}
shouldHandleScroll={props.shouldHandleScroll}
Expand Down
Loading