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.

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

Jump to bottom

Fixes an edge case when the tooltip wouldn't move closer to the mouse cursor in some situations #3663

Merged
merged 2 commits into from
Nov 24, 2021
Merged

Fixes an edge case when the tooltip wouldn't move closer to the mouse cursor in some situations #3663

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
fd8b0da
Fixes an edge case when the tooltip wouldn't move closer to the mouse…
julienw Nov 22, 2021
e63777f
Merge branch 'main' into fix-issue-when-tooltip-goes-from-window-edge…
julienw Nov 24, 2021
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
9 changes: 8 additions & 1 deletion src/components/tooltip/Tooltip.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,14 @@ export class Tooltip extends React.PureComponent<Props> {
newPosition = possiblePositions[0];
break;
case 2:
newPosition = previousPosition;
// In case both positions before/after work, let's reuse the previous
// position if it's one of those, for more stability. If the previous
// position was window-edge, before-mouse looks more appropriate.
// Ideally we would try to keep the tooltip below the cursor.
newPosition =
previousPosition !== 'window-edge'
? previousPosition
: 'before-mouse';
break;
default:
throw new Error(
Expand Down
44 changes: 34 additions & 10 deletions src/test/components/Tooltip.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ describe('shared/Tooltip', () => {

mouseX = 50;
mouseY = 70;
rerender({ x: mouseX, y: mouseY });
rerender({ mouse: { x: mouseX, y: mouseY } });

expect(getTooltipStyle()).toEqual({
left: `${mouseX + MOUSE_OFFSET}px`,
Expand All @@ -63,7 +63,7 @@ describe('shared/Tooltip', () => {
// below/right and above/left will still render the tooltip below/right.
mouseX = 510;
mouseY = 310;
rerender({ x: mouseX, y: mouseY });
rerender({ mouse: { x: mouseX, y: mouseY } });
expect(getTooltipStyle()).toEqual({
left: `${mouseX + MOUSE_OFFSET}px`,
top: `${mouseY + MOUSE_OFFSET}px`,
Expand All @@ -73,7 +73,7 @@ describe('shared/Tooltip', () => {
// available will move the tooltip left/above.
mouseX = 800;
mouseY = 700;
rerender({ x: mouseX, y: mouseY });
rerender({ mouse: { x: mouseX, y: mouseY } });
expect(getTooltipStyle()).toEqual({
left: `${mouseX - MOUSE_OFFSET - tooltipWidth}px`,
top: `${mouseY - MOUSE_OFFSET - tooltipHeight}px`,
Expand Down Expand Up @@ -102,7 +102,7 @@ describe('shared/Tooltip', () => {
// below/right and above/left will still render the tooltip above/left.
mouseX = 510;
mouseY = 310;
rerender({ x: mouseX, y: mouseY });
rerender({ mouse: { x: mouseX, y: mouseY } });
expect(getTooltipStyle()).toEqual({
left: `${expectedLeft()}px`,
top: `${expectedTop()}px`,
Expand All @@ -112,7 +112,7 @@ describe('shared/Tooltip', () => {
// available will move the tooltip right/below.
mouseX = 50;
mouseY = 30;
rerender({ x: mouseX, y: mouseY });
rerender({ mouse: { x: mouseX, y: mouseY } });
expect(getTooltipStyle()).toEqual({
left: `${mouseX + MOUSE_OFFSET}px`,
top: `${mouseY + MOUSE_OFFSET}px`,
Expand All @@ -121,17 +121,36 @@ describe('shared/Tooltip', () => {

it('is rendered at the left and top of the window if the space is missing elsewhere', () => {
// The jsdom window size is 1024x768.
const { getTooltipStyle } = setup({
box: { width: 700, height: 500 },
mouse: { x: 500, y: 300 },
let mouseX = 500;
let mouseY = 300;
let tooltipWidth = 700;
const tooltipHeight = 500;
const { getTooltipStyle, rerender } = setup({
box: { width: tooltipWidth, height: tooltipHeight },
mouse: { x: mouseX, y: mouseY },
});

const expectedLeft = VISUAL_MARGIN;
let expectedLeft = VISUAL_MARGIN;
const expectedTop = VISUAL_MARGIN;
expect(getTooltipStyle()).toEqual({
left: `${expectedLeft}px`,
top: `${expectedTop}px`,
});

// We change the size of the box and move the mouse slightly to trigger a render.
tooltipWidth = 300;
mouseX = 510;
mouseY = 310;
rerender({
box: { width: tooltipWidth, height: tooltipHeight },
mouse: { x: mouseX, y: mouseY },
});

expectedLeft = mouseX - MOUSE_OFFSET - tooltipWidth;
expect(getTooltipStyle()).toEqual({
left: `${expectedLeft}px`,
top: `${expectedTop}px`,
});
});
});
});
Expand Down Expand Up @@ -181,7 +200,12 @@ function setup({ box, mouse }: Setup) {
}

return {
rerender: (mouse: Position) => {
rerender: ({ mouse, box: newBox }: $Shape<Setup>) => {
if (newBox) {
box.width = newBox.width;
box.height = newBox.height;
}

rerender(
<Tooltip mouseX={mouse.x} mouseY={mouse.y}>
<p>Lorem ipsum</p>
Expand Down