Skip to content

feat(vncscreen.tsx): Allow for customization of onMouseEnter and onMouseLeave events #72

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

Open
adryd325 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(vncscreen.tsx): Allow for customization of onMouseEnter and onMouseLeave events #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ed2383
fix: workround for spurious mouseleave events in chrome
richardstephens Oct 9, 2023
a652c7d
feat(vncscreen.tsx): allow customization of mouseenter and mouseleave…
adryd325 Jan 9, 2026
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
24 changes: 19 additions & 5 deletions src/lib/VncScreen.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React, {
forwardRef,
MouseEventHandler,
useEffect,
useImperativeHandle,
useRef,
Expand Down Expand Up @@ -37,6 +38,8 @@ export interface Props {
onDesktopName?: EventListeners['desktopname'];
onCapabilities?: EventListeners['capabilities'];
onClippingViewport?: EventListeners['clippingviewport'];
onChildMouseLeave?: MouseEventHandler<HTMLDivElement>;
onChildMouseEnter?: MouseEventHandler<HTMLDivElement>;
}

export type VncScreenHandle = {
Expand Down Expand Up @@ -84,6 +87,8 @@ const VncScreen: React.ForwardRefRenderFunction<VncScreenHandle, Props> = (props
autoConnect = true,
retryDuration = 3000,
debug = false,
onChildMouseLeave,
onChildMouseEnter,
onConnect,
onDisconnect,
onCredentialsRequired,
Expand Down Expand Up @@ -334,20 +339,29 @@ const VncScreen: React.ForwardRefRenderFunction<VncScreenHandle, Props> = (props
rfb.focus();
};

const handleMouseEnter = () => {
const defaultHandleMouseEnter = () => {
if (document.activeElement && document.activeElement instanceof HTMLElement) {
document.activeElement.blur();
}

handleClick();
};

const handleMouseLeave = () => {
const defaultHandleMouseLeave = (e: React.MouseEvent<HTMLElement>) => {
// https://github.com/roerohan/react-vnc/issues/5#issuecomment-1753065170
// FIXME: We see spurious mouse leave events in Chrome when the user clicks
// on the canvas.
// This hack drops the mouseleave event if the target is the noVNC mouse capture element
if (
e.nativeEvent.relatedTarget &&
(e.nativeEvent.relatedTarget as HTMLElement).id == "noVNC_mouse_capture_elem"
) {
return;
}
const rfb = getRfb();
if (!rfb) {
return;
}

rfb.blur();
};

Expand All @@ -356,8 +370,8 @@ const VncScreen: React.ForwardRefRenderFunction<VncScreenHandle, Props> = (props
style={style}
className={className}
ref={screen}
onMouseEnter={handleMouseEnter}
onMouseLeave={handleMouseLeave}
onMouseEnter={onChildMouseEnter ?? defaultHandleMouseEnter}
onMouseLeave={onChildMouseLeave ?? defaultHandleMouseLeave}
/>
);
}
Expand Down