Skip to content

The Open Source DocuSign Alternative.

fix: ignore presses that start outside the signature pad (#3522)

Catalin Pitbe09a13afcae
diff --git a/packages/ui/primitives/signature-pad/signature-pad-draw.tsx b/packages/ui/primitives/signature-pad/signature-pad-draw.tsx
index c84026b8d..dae740c30 100644
--- a/packages/ui/primitives/signature-pad/signature-pad-draw.tsx
+++ b/packages/ui/primitives/signature-pad/signature-pad-draw.tsx
@@ -6,7 +6,7 @@ import { Undo2 } from 'lucide-react';
import type { StrokeOptions } from 'perfect-freehand';
import { getStroke } from 'perfect-freehand';
import type { MouseEvent, PointerEvent, TouchEvent } from 'react';
-import { useMemo, useRef, useState } from 'react';
+import { useEffect, useMemo, useRef, useState } from 'react';
import { cn } from '../../lib/utils';
import { checkSignatureValidity, getSvgPathFromStroke } from './helper';
@@ -26,6 +26,7 @@ export const SignaturePadDraw = ({ className, value, onChange, ...props }: Signa
const $imageData = useRef<ImageData | null>(null);
const $fileInput = useRef<HTMLInputElement>(null);
+ const $hasPressStartedOnPad = useRef(false);
const [isPressed, setIsPressed] = useState(false);
const [lines, setLines] = useState<Point[][]>([]);
@@ -60,6 +61,17 @@ export const SignaturePadDraw = ({ className, value, onChange, ...props }: Signa
setCurrentLine([point]);
};
+ const onPointerDown = (event: PointerEvent<HTMLCanvasElement>) => {
+ // Right and middle clicks can open a context menu that swallows pointerup, leaving the stroke stuck.
+ if (!event.isPrimary || event.button !== 0) {
+ return;
+ }
+
+ $hasPressStartedOnPad.current = true;
+
+ onMouseDown(event);
+ };
+
const onMouseMove = (event: MouseEvent | PointerEvent | TouchEvent) => {
if (event.cancelable) {
event.preventDefault();
@@ -147,7 +159,9 @@ export const SignaturePadDraw = ({ className, value, onChange, ...props }: Signa
event.preventDefault();
}
- if ('buttons' in event && event.buttons === 1) {
+ // A press can already be held when the pad mounts (e.g. the one that opened it), so only
+ // resume strokes that started on the pad.
+ if ($hasPressStartedOnPad.current && 'buttons' in event && event.buttons === 1) {
onMouseDown(event);
}
};
@@ -213,6 +227,19 @@ export const SignaturePadDraw = ({ className, value, onChange, ...props }: Signa
onChange(isValidSignature ? $el.current.toDataURL() : '');
};
+ useEffect(() => {
+ // Releasing outside the pad never reaches the canvas.
+ const onWindowPointerUp = () => {
+ $hasPressStartedOnPad.current = false;
+ };
+
+ window.addEventListener('pointerup', onWindowPointerUp);
+
+ return () => {
+ window.removeEventListener('pointerup', onWindowPointerUp);
+ };
+ }, []);
+
unsafe_useEffectOnce(() => {
if ($el.current) {
$el.current.width = $el.current.clientWidth * SIGNATURE_CANVAS_DPI;
@@ -248,7 +275,7 @@ export const SignaturePadDraw = ({ className, value, onChange, ...props }: Signa
})}
style={{ touchAction: 'none' }}
onPointerMove={(event) => onMouseMove(event)}
- onPointerDown={(event) => onMouseDown(event)}
+ onPointerDown={(event) => onPointerDown(event)}
onPointerUp={(event) => onMouseUp(event)}
onPointerLeave={(event) => onMouseLeave(event)}
onPointerEnter={(event) => onMouseEnter(event)}