Skip to content

Fix how hovering tooltip is handled to keep tooltip open #1245

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 2 commits into from
Apr 8, 2025
Merged

Fix how hovering tooltip is handled to keep tooltip open #1245

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
687f1ca
fix: handle hovering tooltip correctly
gabrieljablonski Apr 7, 2025
53717f8
fix: clear `mouseover` and `mouseout` when `imperativeModeOnly` is true
gabrieljablonski Apr 7, 2025
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
28 changes: 16 additions & 12 deletions src/components/Tooltip/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,15 +147,17 @@ const Tooltip = ({

if (imperativeModeOnly) {
Object.assign(actualOpenEvents, {
mouseenter: false,
mouseover: false,
focus: false,
mouseenter: false,
click: false,
dblclick: false,
mousedown: false,
})
Object.assign(actualCloseEvents, {
mouseleave: false,
mouseout: false,
blur: false,
mouseleave: false,
click: false,
dblclick: false,
mouseup: false,
Expand Down Expand Up @@ -573,19 +575,21 @@ const Tooltip = ({
})
}

const handleMouseEnterTooltip = () => {
const handleMouseOverTooltip = () => {
hoveringTooltip.current = true
}
const handleMouseLeaveTooltip = () => {
const handleMouseOutTooltip = () => {
hoveringTooltip.current = false
handleHideTooltip()
}

if (clickable && !hasClickEvent) {
// used to keep the tooltip open when hovering content.
// not needed if using click events.
tooltipRef.current?.addEventListener('mouseenter', handleMouseEnterTooltip)
tooltipRef.current?.addEventListener('mouseleave', handleMouseLeaveTooltip)
const addHoveringTooltipListeners =
clickable && (actualCloseEvents.mouseout || actualCloseEvents.mouseleave)
if (addHoveringTooltipListeners) {
// used to keep the tooltip open when hovering from anchor to tooltip.
// only relevant if either `mouseout`/`mouseleave` is in use
tooltipRef.current?.addEventListener('mouseover', handleMouseOverTooltip)
tooltipRef.current?.addEventListener('mouseout', handleMouseOutTooltip)
Comment on lines +591 to +592
Copy link
Member Author

Choose a reason for hiding this comment

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

Changed for consistency, since we favor mouseover/mouseout as the default hover events.

}

enabledEvents.forEach(({ event, listener }) => {
Expand All @@ -611,9 +615,9 @@ const Tooltip = ({
if (actualGlobalCloseEvents.escape) {
window.removeEventListener('keydown', handleEsc)
}
if (clickable && !hasClickEvent) {
tooltipRef.current?.removeEventListener('mouseenter', handleMouseEnterTooltip)
tooltipRef.current?.removeEventListener('mouseleave', handleMouseLeaveTooltip)
if (addHoveringTooltipListeners) {
tooltipRef.current?.removeEventListener('mouseover', handleMouseOverTooltip)
tooltipRef.current?.removeEventListener('mouseout', handleMouseOutTooltip)
}
enabledEvents.forEach(({ event, listener }) => {
elementRefs.forEach((ref) => {
Expand Down