Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
10 changes: 6 additions & 4 deletions src/renderer/components/fields/Tooltip.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,26 @@ describe('renderer/components/fields/Tooltip.tsx', () => {

const tooltipIconElement = screen.getByTestId('tooltip-icon-test');

// Open tooltip
await userEvent.click(tooltipIconElement);
expect(screen.queryByText(props.tooltip as string)).toBeInTheDocument();

// Close tooltip
await userEvent.click(tooltipIconElement);
expect(screen.queryByText(props.tooltip as string)).not.toBeInTheDocument();
});

it('should hide tooltip contents on leave', async () => {
it('should hide tooltip when clicking outside', async () => {
renderWithAppContext(<Tooltip {...props} />);

const tooltipIconElement = screen.getByTestId('tooltip-icon-test');

// Open tooltip
await userEvent.click(tooltipIconElement);
expect(screen.queryByText(props.tooltip as string)).toBeInTheDocument();

const tooltipContentElement = screen.getByTestId('tooltip-content-test');

await userEvent.unhover(tooltipContentElement);
// Click outside to close
await userEvent.click(document.body);
expect(screen.queryByText(props.tooltip as string)).not.toBeInTheDocument();
});
});
60 changes: 58 additions & 2 deletions src/renderer/components/fields/Tooltip.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { type FC, type ReactNode, useState } from 'react';
import { type FC, type ReactNode, useEffect, useRef, useState } from 'react';

import { QuestionIcon } from '@primer/octicons-react';
import { AnchoredOverlay } from '@primer/react';
Expand All @@ -12,6 +12,62 @@ export interface TooltipProps {

export const Tooltip: FC<TooltipProps> = (props: TooltipProps) => {
const [showTooltip, setShowTooltip] = useState(false);
const scrollContainerRef = useRef<HTMLElement | null>(null);
const overlayRef = useRef<HTMLDivElement>(null);

useEffect(() => {
if (!showTooltip) {
return;
}

// Find the scrollable parent container
const findScrollContainer = (
element: HTMLElement | null,
): HTMLElement | null => {
if (!element) {
return null;
}

const { overflow, overflowY } = window.getComputedStyle(element);
const isScrollable = /(auto|scroll)/.test(overflow + overflowY);

if (isScrollable && element.scrollHeight > element.clientHeight) {
return element;
}

return findScrollContainer(element.parentElement);
};

const tooltipButton = document.getElementById(props.name);
scrollContainerRef.current = findScrollContainer(tooltipButton);

const handleScroll = () => {
setShowTooltip(false);
};

const handleClickOutside = (event: MouseEvent) => {
if (
overlayRef.current &&
!overlayRef.current.contains(event.target as Node) &&
!tooltipButton?.contains(event.target as Node)
) {
setShowTooltip(false);
}
};

if (scrollContainerRef.current) {
scrollContainerRef.current.addEventListener('scroll', handleScroll);
}

document.addEventListener('mousedown', handleClickOutside);

return () => {
if (scrollContainerRef.current) {
scrollContainerRef.current.removeEventListener('scroll', handleScroll);
}
document.removeEventListener('mousedown', handleClickOutside);
};
}, [showTooltip, props.name]);

return (
<AnchoredOverlay
Expand All @@ -38,7 +94,7 @@ export const Tooltip: FC<TooltipProps> = (props: TooltipProps) => {
'rounded-sm border border-gray-300 shadow-sm bg-gitify-tooltip-popout',
)}
data-testid={`tooltip-content-${props.name}`}
onMouseLeave={() => setShowTooltip(false)}
ref={overlayRef}
role="tooltip"
>
{props.tooltip}
Expand Down