Skip to content

fix: support pointer events in useLongPress #2947

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
wanxiankai wants to merge 1 commit into
base: master
Choose a base branch
from
+122 −33
Open

fix: support pointer events in useLongPress #2947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions packages/hooks/src/useLongPress/__tests__/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,48 @@ describe('useLongPress', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.clearAllMocks();
vi.stubGlobal('PointerEvent', undefined);
});

afterEach(() => {
events = {};
vi.useRealTimers();
vi.unstubAllGlobals();
vi.clearAllMocks();
});

test('uses pointer events when available', () => {
class MockPointerEvent extends MouseEvent {
isPrimary: boolean;

constructor(type: string, eventInitDict?: MouseEventInit & { isPrimary?: boolean }) {
super(type, eventInitDict);
this.isPrimary = eventInitDict?.isPrimary ?? true;
}
}

vi.stubGlobal('PointerEvent', MockPointerEvent);

setup(mockCallback, mockTarget, {
onClick: mockClickCallback,
onLongPressEnd: mockLongPressEndCallback,
});
expect(events.pointerdown).toBeDefined();
expect(events.pointerup).toBeDefined();
expect(events.mousedown).toBeUndefined();

events.pointerdown(new PointerEvent('pointerdown'));
vi.advanceTimersByTime(350);
events.pointerup(new PointerEvent('pointerup'));

events.pointerdown(new PointerEvent('pointerdown'));
events.pointerup(new PointerEvent('pointerup'));

expect(mockCallback).toHaveBeenCalledTimes(1);
expect(mockLongPressEndCallback).toHaveBeenCalledTimes(1);
expect(mockClickCallback).toHaveBeenCalledTimes(1);
});

test('longPress callback correct', () => {
setup(mockCallback, mockTarget, {
onClick: mockClickCallback,
Expand Down
121 changes: 88 additions & 33 deletions packages/hooks/src/useLongPress/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ function useLongPress(

const isTriggeredRef = useRef(false);
const pervPositionRef = useRef({ x: 0, y: 0 });
const pointerPressed = useRef(false);
const mousePressed = useRef(false);
const touchPressed = useRef(false);
const hasMoveThreshold = !!(
Expand All @@ -38,6 +39,8 @@ function useLongPress(
if (!targetElement?.addEventListener) {
return;
}
const supportPointerEvent =
typeof window !== 'undefined' && typeof window.PointerEvent === 'function';

const overThreshold = (event: EventType) => {
const { clientX, clientY } = getClientPosition(event);
Expand Down Expand Up @@ -74,6 +77,53 @@ function useLongPress(
}, delay);
};

const clearTimer = () => {
if (timerRef.current) {
clearTimeout(timerRef.current);
timerRef.current = undefined;
}
};

const finishPress = (event: EventType, triggerClick = true) => {
clearTimer();

if (isTriggeredRef.current) {
onLongPressEndRef.current?.(event);
} else if (triggerClick && onClickRef.current) {
onClickRef.current(event);
}
isTriggeredRef.current = false;
};

const onPointerDown = (event: PointerEvent) => {
if (pointerPressed.current || event.isPrimary === false) {
return;
}
pointerPressed.current = true;

if (hasMoveThreshold) {
pervPositionRef.current.x = event.clientX;
pervPositionRef.current.y = event.clientY;
}
createTimer(event);
};

const onPointerUp = (event: PointerEvent) => {
if (!pointerPressed.current || event.isPrimary === false) {
return;
}
pointerPressed.current = false;
finishPress(event);
};

const onPointerCancel = (event: PointerEvent) => {
if (!pointerPressed.current || event.isPrimary === false) {
return;
}
pointerPressed.current = false;
finishPress(event, false);
};

const onTouchStart = (event: TouchEvent) => {
if (touchPressed.current) {
return;
Expand Down Expand Up @@ -104,8 +154,7 @@ function useLongPress(

const onMove = (event: EventType) => {
if (timerRef.current && overThreshold(event)) {
clearTimeout(timerRef.current);
timerRef.current = undefined;
clearTimer();
}
};

Expand All @@ -115,17 +164,7 @@ function useLongPress(
}
touchPressed.current = false;

if (timerRef.current) {
clearTimeout(timerRef.current);
timerRef.current = undefined;
}

if (isTriggeredRef.current) {
onLongPressEndRef.current?.(event);
} else if (onClickRef.current) {
onClickRef.current(event);
}
isTriggeredRef.current = false;
finishPress(event);
};

const onMouseUp = (event: MouseEvent) => {
Expand All @@ -137,17 +176,7 @@ function useLongPress(
}
mousePressed.current = false;

if (timerRef.current) {
clearTimeout(timerRef.current);
timerRef.current = undefined;
}

if (isTriggeredRef.current) {
onLongPressEndRef.current?.(event);
} else if (onClickRef.current) {
onClickRef.current(event);
}
isTriggeredRef.current = false;
finishPress(event);
};

const onMouseLeave = (event: MouseEvent) => {
Expand All @@ -156,38 +185,64 @@ function useLongPress(
}
mousePressed.current = false;

if (timerRef.current) {
clearTimeout(timerRef.current);
timerRef.current = undefined;
finishPress(event, false);
};

if (supportPointerEvent) {
targetElement.addEventListener('pointerdown', onPointerDown as EventListener);
targetElement.addEventListener('pointerup', onPointerUp as EventListener);
targetElement.addEventListener('pointerleave', onPointerCancel as EventListener);
targetElement.addEventListener('pointercancel', onPointerCancel as EventListener);

if (hasMoveThreshold) {
targetElement.addEventListener('pointermove', onMove as EventListener);
}
if (isTriggeredRef.current) {
onLongPressEndRef.current?.(event);

return () => {
clearTimer();
isTriggeredRef.current = false;

targetElement.removeEventListener('pointerdown', onPointerDown as EventListener);
targetElement.removeEventListener('pointerup', onPointerUp as EventListener);
targetElement.removeEventListener('pointerleave', onPointerCancel as EventListener);
targetElement.removeEventListener('pointercancel', onPointerCancel as EventListener);

if (hasMoveThreshold) {
targetElement.removeEventListener('pointermove', onMove as EventListener);
}
};
}

const onTouchCancel = (event: TouchEvent) => {
if (!touchPressed.current) {
return;
}
touchPressed.current = false;
finishPress(event, false);
};

targetElement.addEventListener('mousedown', onMouseDown as EventListener);
targetElement.addEventListener('mouseup', onMouseUp as EventListener);
targetElement.addEventListener('mouseleave', onMouseLeave as EventListener);
targetElement.addEventListener('touchstart', onTouchStart as EventListener);
targetElement.addEventListener('touchend', onTouchEnd as EventListener);
targetElement.addEventListener('touchcancel', onTouchCancel as EventListener);

if (hasMoveThreshold) {
targetElement.addEventListener('mousemove', onMove as EventListener);
targetElement.addEventListener('touchmove', onMove as EventListener);
}

return () => {
if (timerRef.current) {
clearTimeout(timerRef.current);
isTriggeredRef.current = false;
}
clearTimer();
isTriggeredRef.current = false;

targetElement.removeEventListener('mousedown', onMouseDown as EventListener);
targetElement.removeEventListener('mouseup', onMouseUp as EventListener);
targetElement.removeEventListener('mouseleave', onMouseLeave as EventListener);
targetElement.removeEventListener('touchstart', onTouchStart as EventListener);
targetElement.removeEventListener('touchend', onTouchEnd as EventListener);
targetElement.removeEventListener('touchcancel', onTouchCancel as EventListener);

if (hasMoveThreshold) {
targetElement.removeEventListener('mousemove', onMove as EventListener);
Expand Down