-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathusePress.ts
More file actions
1087 lines (955 loc) · 37.3 KB
/
usePress.ts
File metadata and controls
1087 lines (955 loc) · 37.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2020 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
// Portions of the code in this file are based on code from react.
// Original licensing for the following can be found in the
// NOTICE file in the root directory of this source tree.
// See https://github.com/facebook/react/tree/cc7c1aece46a6b69b41958d731e0fd27c94bfc6c/packages/react-interactions
import {chain} from '../utils/chain';
import {createSyntheticEvent, preventFocus, setEventTarget} from './utils';
import {disableTextSelection, restoreTextSelection} from './textSelection';
import {DOMAttributes, FocusableElement, PressEvent as IPressEvent, PointerType, PressEvents, RefObject} from '@react-types/shared';
import {flushSync} from 'react-dom';
import {focusWithoutScrolling} from '../utils/focusWithoutScrolling';
import {getEventTarget, nodeContains} from '../utils/shadowdom/DOMFunctions';
import {getNonce} from '../utils/getNonce';
import {getOwnerDocument, getOwnerWindow} from '../utils/domHelpers';
import {isMac} from '../utils/platform';
import {isVirtualClick, isVirtualPointerEvent} from '../utils/isVirtualEvent';
import {mergeProps} from '../utils/mergeProps';
import {openLink} from '../utils/openLink';
import {PressResponderContext} from './context';
import {MouseEvent as RMouseEvent, TouchEvent as RTouchEvent, useCallback, useContext, useEffect, useMemo, useRef, useState} from 'react';
import {useEffectEvent} from '../utils/useEffectEvent';
import {useGlobalListeners} from '../utils/useGlobalListeners';
import {useSyncRef} from '../utils/useSyncRef';
export interface PressProps extends PressEvents {
/** Whether the target is in a controlled press state (e.g. an overlay it triggers is open). */
isPressed?: boolean,
/** Whether the press events should be disabled. */
isDisabled?: boolean,
/** Whether the target should not receive focus on press. */
preventFocusOnPress?: boolean,
/**
* Whether press events should be canceled when the pointer leaves the target while pressed.
* By default, this is `false`, which means if the pointer returns back over the target while
* still pressed, onPressStart will be fired again. If set to `true`, the press is canceled
* when the pointer leaves the target and onPressStart will not be fired if the pointer returns.
*/
shouldCancelOnPointerExit?: boolean,
/** Whether text selection should be enabled on the pressable element. */
allowTextSelectionOnPress?: boolean
}
export interface PressHookProps extends PressProps {
/** A ref to the target element. */
ref?: RefObject<Element | null>
}
interface PressState {
isPressed: boolean,
ignoreEmulatedMouseEvents: boolean,
didFirePressStart: boolean,
isTriggeringEvent: boolean,
activePointerId: any,
target: FocusableElement | null,
isOverTarget: boolean,
pointerType: PointerType | null,
userSelect?: string,
metaKeyEvents?: Map<string, globalThis.KeyboardEvent>,
disposables: Array<() => void>
}
interface EventBase {
currentTarget: EventTarget | null,
shiftKey: boolean,
ctrlKey: boolean,
metaKey: boolean,
altKey: boolean,
clientX?: number,
clientY?: number,
targetTouches?: Array<{clientX?: number, clientY?: number}>,
key?: string
}
export interface PressResult {
/** Whether the target is currently pressed. */
isPressed: boolean,
/** Props to spread on the target element. */
pressProps: DOMAttributes
}
function usePressResponderContext(props: PressHookProps): PressHookProps {
// Consume context from <PressResponder> and merge with props.
let context = useContext(PressResponderContext);
if (context) {
// Prevent mergeProps from merging ref.
// eslint-disable-next-line @typescript-eslint/no-unused-vars
let {register, ref, ...contextProps} = context;
props = mergeProps(contextProps, props) as PressHookProps;
register();
}
useSyncRef(context, props.ref);
return props;
}
class PressEvent implements IPressEvent {
type: IPressEvent['type'];
pointerType: PointerType;
target: Element;
shiftKey: boolean;
ctrlKey: boolean;
metaKey: boolean;
altKey: boolean;
x: number;
y: number;
key: string | undefined;
#shouldStopPropagation = true;
constructor(type: IPressEvent['type'], pointerType: PointerType, originalEvent: EventBase, state?: PressState) {
let currentTarget = state?.target ?? originalEvent.currentTarget;
const rect: DOMRect | undefined = (currentTarget as Element)?.getBoundingClientRect();
let x, y = 0;
let clientX, clientY: number | null = null;
if (originalEvent.clientX != null && originalEvent.clientY != null) {
clientX = originalEvent.clientX;
clientY = originalEvent.clientY;
}
if (rect) {
if (clientX != null && clientY != null) {
x = clientX - rect.left;
y = clientY - rect.top;
} else {
x = rect.width / 2;
y = rect.height / 2;
}
}
this.type = type;
this.pointerType = pointerType;
this.target = originalEvent.currentTarget as Element;
this.shiftKey = originalEvent.shiftKey;
this.metaKey = originalEvent.metaKey;
this.ctrlKey = originalEvent.ctrlKey;
this.altKey = originalEvent.altKey;
this.x = x;
this.y = y;
this.key = originalEvent.key;
}
continuePropagation() {
this.#shouldStopPropagation = false;
}
get shouldStopPropagation() {
return this.#shouldStopPropagation;
}
}
const LINK_CLICKED = Symbol('linkClicked');
const STYLE_ID = 'react-aria-pressable-style';
const PRESSABLE_ATTRIBUTE = 'data-react-aria-pressable';
/**
* Handles press interactions across mouse, touch, keyboard, and screen readers.
* It normalizes behavior across browsers and platforms, and handles many nuances
* of dealing with pointer and keyboard events.
*/
export function usePress(props: PressHookProps): PressResult {
let {
onPress,
onPressChange,
onPressStart,
onPressEnd,
onPressUp,
onClick,
isDisabled,
isPressed: isPressedProp,
preventFocusOnPress,
shouldCancelOnPointerExit,
allowTextSelectionOnPress,
ref: domRef,
...domProps
} = usePressResponderContext(props);
let [isPressed, setPressed] = useState(false);
let ref = useRef<PressState>({
isPressed: false,
ignoreEmulatedMouseEvents: false,
didFirePressStart: false,
isTriggeringEvent: false,
activePointerId: null,
target: null,
isOverTarget: false,
pointerType: null,
disposables: []
});
let isDisabledRef = useRef(isDisabled);
useEffect(() => {
isDisabledRef.current = isDisabled;
}, [isDisabled]);
let {addGlobalListener, removeAllGlobalListeners} = useGlobalListeners();
let triggerPressStart = useCallback((originalEvent: EventBase, pointerType: PointerType) => {
let state = ref.current;
if (isDisabled || state.didFirePressStart) {
return false;
}
let shouldStopPropagation = true;
state.isTriggeringEvent = true;
if (onPressStart) {
let event = new PressEvent('pressstart', pointerType, originalEvent);
onPressStart(event);
shouldStopPropagation = event.shouldStopPropagation;
}
if (onPressChange) {
onPressChange(true);
}
state.isTriggeringEvent = false;
state.didFirePressStart = true;
setPressed(true);
return shouldStopPropagation;
}, [isDisabled, onPressStart, onPressChange]);
let triggerPressEnd = useCallback((originalEvent: EventBase, pointerType: PointerType, wasPressed = true) => {
let state = ref.current;
if (!state.didFirePressStart) {
return false;
}
state.didFirePressStart = false;
state.isTriggeringEvent = true;
let shouldStopPropagation = true;
if (onPressEnd) {
let event = new PressEvent('pressend', pointerType, originalEvent);
onPressEnd(event);
shouldStopPropagation = event.shouldStopPropagation;
}
if (onPressChange) {
onPressChange(false);
}
setPressed(false);
if (onPress && wasPressed && !isDisabled) {
let event = new PressEvent('press', pointerType, originalEvent);
onPress(event);
shouldStopPropagation &&= event.shouldStopPropagation;
}
state.isTriggeringEvent = false;
return shouldStopPropagation;
}, [isDisabled, onPressEnd, onPressChange, onPress]);
let triggerPressEndEvent = useEffectEvent(triggerPressEnd);
let triggerPressUp = useCallback((originalEvent: EventBase, pointerType: PointerType) => {
let state = ref.current;
if (isDisabled) {
return false;
}
if (onPressUp) {
state.isTriggeringEvent = true;
let event = new PressEvent('pressup', pointerType, originalEvent);
onPressUp(event);
state.isTriggeringEvent = false;
return event.shouldStopPropagation;
}
return true;
}, [isDisabled, onPressUp]);
let triggerPressUpEvent = useEffectEvent(triggerPressUp);
let cancel = useCallback((e: EventBase) => {
let state = ref.current;
if (state.isPressed && state.target) {
if (state.didFirePressStart && state.pointerType != null) {
triggerPressEnd(createEvent(state.target, e), state.pointerType, false);
}
state.isPressed = false;
state.isOverTarget = false;
state.activePointerId = null;
state.pointerType = null;
removeAllGlobalListeners();
if (!allowTextSelectionOnPress) {
restoreTextSelection(state.target);
}
for (let dispose of state.disposables) {
dispose();
}
state.disposables = [];
}
}, [allowTextSelectionOnPress, removeAllGlobalListeners, triggerPressEnd]);
let cancelEvent = useEffectEvent(cancel);
let cancelOnPointerExit = useCallback((e: EventBase) => {
if (shouldCancelOnPointerExit) {
cancel(e);
}
}, [shouldCancelOnPointerExit, cancel]);
let triggerClick = useCallback((e: RMouseEvent<FocusableElement>) => {
if (isDisabled) {
return;
}
onClick?.(e);
}, [isDisabled, onClick]);
let triggerSyntheticClick = useCallback((e: KeyboardEvent | TouchEvent, target: FocusableElement) => {
if (isDisabled) {
return;
}
// Some third-party libraries pass in onClick instead of onPress.
// Create a fake mouse event and trigger onClick as well.
// This matches the browser's native activation behavior for certain elements (e.g. button).
// https://html.spec.whatwg.org/#activation
// https://html.spec.whatwg.org/#fire-a-synthetic-pointer-event
if (onClick) {
let event = new MouseEvent('click', e);
setEventTarget(event, target);
onClick(createSyntheticEvent(event));
}
}, [isDisabled, onClick]);
let pressProps = useMemo(() => {
let state = ref.current;
let pressProps: DOMAttributes = {
onKeyDown(e) {
if (isValidKeyboardEvent(e.nativeEvent, e.currentTarget as Element) && nodeContains(e.currentTarget as Element, getEventTarget(e) as Element)) {
if (shouldPreventDefaultKeyboard(getEventTarget(e) as Element, e.key)) {
e.preventDefault();
}
// If the event is repeating, it may have started on a different element
// after which focus moved to the current element. Ignore these events and
// only handle the first key down event.
let shouldStopPropagation = true;
if (!state.isPressed && !e.repeat) {
state.target = e.currentTarget;
state.isPressed = true;
state.pointerType = 'keyboard';
shouldStopPropagation = triggerPressStart(e, 'keyboard');
}
// Focus may move before the key up event, so register the event on the document
// instead of the same element where the key down event occurred. Make it capturing so that it will trigger
// before stopPropagation from useKeyboard on a child element may happen and thus we can still call triggerPress for the parent element.
let originalTarget = e.currentTarget;
let pressUp = (e) => {
if (isValidKeyboardEvent(e, originalTarget) && !e.repeat && nodeContains(originalTarget, getEventTarget(e) as Element) && state.target) {
// eslint-disable-next-line react-hooks/rules-of-hooks
triggerPressUpEvent(createEvent(state.target, e), 'keyboard');
}
};
addGlobalListener(getOwnerDocument(e.currentTarget), 'keyup', chain(pressUp, onKeyUp), true);
if (shouldStopPropagation) {
e.stopPropagation();
}
// Keep track of the keydown events that occur while the Meta (e.g. Command) key is held.
// macOS has a bug where keyup events are not fired while the Meta key is down.
// When the Meta key itself is released we will get an event for that, and we'll act as if
// all of these other keys were released as well.
// https://bugs.chromium.org/p/chromium/issues/detail?id=1393524
// https://bugs.webkit.org/show_bug.cgi?id=55291
// https://bugzilla.mozilla.org/show_bug.cgi?id=1299553
if (e.metaKey && isMac()) {
state.metaKeyEvents?.set(e.key, e.nativeEvent);
}
} else if (e.key === 'Meta') {
state.metaKeyEvents = new Map();
}
},
onClick(e) {
if (e && !nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
if (e && e.button === 0 && !state.isTriggeringEvent && !(openLink as any).isOpening) {
let shouldStopPropagation = true;
if (isDisabled) {
e.preventDefault();
}
// If triggered from a screen reader or by using element.click(),
// trigger as if it were a keyboard click.
if (!state.ignoreEmulatedMouseEvents && !state.isPressed && (state.pointerType === 'virtual' || isVirtualClick(e.nativeEvent))) {
let stopPressStart = triggerPressStart(e, 'virtual');
// eslint-disable-next-line react-hooks/rules-of-hooks
let stopPressUp = triggerPressUpEvent(e, 'virtual');
// eslint-disable-next-line react-hooks/rules-of-hooks
let stopPressEnd = triggerPressEndEvent(e, 'virtual');
triggerClick(e);
shouldStopPropagation = stopPressStart && stopPressUp && stopPressEnd;
} else if (state.isPressed && state.pointerType !== 'keyboard') {
let pointerType = state.pointerType || (e.nativeEvent as PointerEvent).pointerType as PointerType || 'virtual';
// eslint-disable-next-line react-hooks/rules-of-hooks
let stopPressUp = triggerPressUpEvent(createEvent(e.currentTarget, e), pointerType);
// eslint-disable-next-line react-hooks/rules-of-hooks
let stopPressEnd = triggerPressEndEvent(createEvent(e.currentTarget, e), pointerType, true);
shouldStopPropagation = stopPressUp && stopPressEnd;
state.isOverTarget = false;
triggerClick(e);
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
}
state.ignoreEmulatedMouseEvents = false;
if (shouldStopPropagation) {
e.stopPropagation();
}
}
}
};
let onKeyUp = (e: KeyboardEvent) => {
if (state.isPressed && state.target && isValidKeyboardEvent(e, state.target)) {
if (shouldPreventDefaultKeyboard(getEventTarget(e) as Element, e.key)) {
e.preventDefault();
}
let target = getEventTarget(e);
let wasPressed = nodeContains(state.target, target as Element);
// eslint-disable-next-line react-hooks/rules-of-hooks
triggerPressEndEvent(createEvent(state.target, e), 'keyboard', wasPressed);
if (wasPressed) {
triggerSyntheticClick(e, state.target);
}
removeAllGlobalListeners();
// If a link was triggered with a key other than Enter, open the URL ourselves.
// This means the link has a role override, and the default browser behavior
// only applies when using the Enter key.
if (e.key !== 'Enter' && isHTMLAnchorLink(state.target) && nodeContains(state.target, target as Element) && !e[LINK_CLICKED]) {
// Store a hidden property on the event so we only trigger link click once,
// even if there are multiple usePress instances attached to the element.
e[LINK_CLICKED] = true;
openLink(state.target, e, false);
}
state.isPressed = false;
state.metaKeyEvents?.delete(e.key);
} else if (e.key === 'Meta' && state.metaKeyEvents?.size) {
// If we recorded keydown events that occurred while the Meta key was pressed,
// and those haven't received keyup events already, fire keyup events ourselves.
// See comment above for more info about the macOS bug causing this.
let events = state.metaKeyEvents;
state.metaKeyEvents = undefined;
for (let event of events.values()) {
state.target?.dispatchEvent(new KeyboardEvent('keyup', event));
}
}
};
if (typeof PointerEvent !== 'undefined') {
pressProps.onPointerDown = (e) => {
// Only handle left clicks, and ignore events that bubbled through portals.
if (e.button !== 0 || !nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
// iOS safari fires pointer events from VoiceOver with incorrect coordinates/target.
// Ignore and let the onClick handler take care of it instead.
// https://bugs.webkit.org/show_bug.cgi?id=222627
// https://bugs.webkit.org/show_bug.cgi?id=223202
if (isVirtualPointerEvent(e.nativeEvent)) {
state.pointerType = 'virtual';
return;
}
state.pointerType = e.pointerType;
let shouldStopPropagation = true;
if (!state.isPressed) {
state.isPressed = true;
state.isOverTarget = true;
state.activePointerId = e.pointerId;
state.target = e.currentTarget as FocusableElement;
if (!allowTextSelectionOnPress) {
disableTextSelection(state.target);
}
shouldStopPropagation = triggerPressStart(e, state.pointerType);
// Release pointer capture so that touch interactions can leave the original target.
// This enables onPointerLeave and onPointerEnter to fire.
let target = getEventTarget(e);
if ('releasePointerCapture' in target) {
if ('hasPointerCapture' in target) {
if (target.hasPointerCapture(e.pointerId)) {
target.releasePointerCapture(e.pointerId);
}
} else {
(target as Element).releasePointerCapture(e.pointerId);
}
}
addGlobalListener(getOwnerDocument(e.currentTarget), 'pointerup', onPointerUp, false);
addGlobalListener(getOwnerDocument(e.currentTarget), 'pointercancel', onPointerCancel, false);
}
if (shouldStopPropagation) {
e.stopPropagation();
}
};
pressProps.onMouseDown = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
if (e.button === 0) {
if (preventFocusOnPress) {
let dispose = preventFocus(e.target as FocusableElement);
if (dispose) {
state.disposables.push(dispose);
}
}
e.stopPropagation();
}
};
pressProps.onPointerUp = (e) => {
// iOS fires pointerup with zero width and height, so check the pointerType recorded during pointerdown.
if (!nodeContains(e.currentTarget, getEventTarget(e)) || state.pointerType === 'virtual') {
return;
}
// Only handle left clicks. If isPressed is true, delay until onClick.
if (e.button === 0 && !state.isPressed) {
// eslint-disable-next-line react-hooks/rules-of-hooks
triggerPressUpEvent(e, state.pointerType || e.pointerType);
}
};
pressProps.onPointerEnter = (e) => {
if (e.pointerId === state.activePointerId && state.target && !state.isOverTarget && state.pointerType != null) {
state.isOverTarget = true;
triggerPressStart(createEvent(state.target, e), state.pointerType);
}
};
pressProps.onPointerLeave = (e) => {
if (e.pointerId === state.activePointerId && state.target && state.isOverTarget && state.pointerType != null) {
state.isOverTarget = false;
// eslint-disable-next-line react-hooks/rules-of-hooks
triggerPressEndEvent(createEvent(state.target, e), state.pointerType, false);
cancelOnPointerExit(e);
}
};
let onPointerUp = (e: PointerEvent) => {
if (e.pointerId === state.activePointerId && state.isPressed && e.button === 0 && state.target) {
if (nodeContains(state.target, getEventTarget(e) as Element) && state.pointerType != null) {
// Wait for onClick to fire onPress. This avoids browser issues when the DOM
// is mutated between onPointerUp and onClick, and is more compatible with third party libraries.
// https://github.com/adobe/react-spectrum/issues/1513
// https://issues.chromium.org/issues/40732224
// However, iOS and Android do not focus or fire onClick after a long press.
// We work around this by triggering a click ourselves after a timeout.
// This timeout is canceled during the click event in case the real one fires first.
// The timeout must be at least 32ms, because Safari on iOS delays the click event on
// non-form elements without certain ARIA roles (for hover emulation).
// https://github.com/WebKit/WebKit/blob/dccfae42bb29bd4bdef052e469f604a9387241c0/Source/WebKit/WebProcess/WebPage/ios/WebPageIOS.mm#L875-L892
let clicked = false;
let timeout = setTimeout(() => {
if (state.isPressed && state.target instanceof HTMLElement) {
if (clicked || (state.isPressed && isDisabledRef.current)) {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
} else {
focusWithoutScrolling(state.target);
state.target.click();
}
}
}, 80);
// Use a capturing listener to track if a click occurred.
// If stopPropagation is called it may never reach our handler.
addGlobalListener(e.currentTarget as Document, 'click', () => clicked = true, true);
state.disposables.push(() => clearTimeout(timeout));
} else {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
}
// Ignore subsequent onPointerLeave event before onClick on touch devices.
state.isOverTarget = false;
}
};
let onPointerCancel = (e: PointerEvent) => {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
};
pressProps.onDragStart = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
// Safari does not call onPointerCancel when a drag starts, whereas Chrome and Firefox do.
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
};
} else if (process.env.NODE_ENV === 'test') {
// NOTE: this fallback branch is entirely used by unit tests.
// All browsers now support pointer events, but JSDOM still does not.
pressProps.onMouseDown = (e) => {
// Only handle left clicks
if (e.button !== 0 || !nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
if (state.ignoreEmulatedMouseEvents) {
e.stopPropagation();
return;
}
state.isPressed = true;
state.isOverTarget = true;
state.target = e.currentTarget;
state.pointerType = isVirtualClick(e.nativeEvent) ? 'virtual' : 'mouse';
// Flush sync so that focus moved during react re-renders occurs before we yield back to the browser.
let shouldStopPropagation = flushSync(() => triggerPressStart(e, state.pointerType!));
if (shouldStopPropagation) {
e.stopPropagation();
}
if (preventFocusOnPress) {
let dispose = preventFocus(e.target as FocusableElement);
if (dispose) {
state.disposables.push(dispose);
}
}
addGlobalListener(getOwnerDocument(e.currentTarget), 'mouseup', onMouseUp, false);
};
pressProps.onMouseEnter = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
let shouldStopPropagation = true;
if (state.isPressed && !state.ignoreEmulatedMouseEvents && state.pointerType != null) {
state.isOverTarget = true;
shouldStopPropagation = triggerPressStart(e, state.pointerType);
}
if (shouldStopPropagation) {
e.stopPropagation();
}
};
pressProps.onMouseLeave = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
let shouldStopPropagation = true;
if (state.isPressed && !state.ignoreEmulatedMouseEvents && state.pointerType != null) {
state.isOverTarget = false;
// eslint-disable-next-line react-hooks/rules-of-hooks
shouldStopPropagation = triggerPressEndEvent(e, state.pointerType, false);
cancelOnPointerExit(e);
}
if (shouldStopPropagation) {
e.stopPropagation();
}
};
pressProps.onMouseUp = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
if (!state.ignoreEmulatedMouseEvents && e.button === 0 && !state.isPressed) {
// eslint-disable-next-line react-hooks/rules-of-hooks
triggerPressUpEvent(e, state.pointerType || 'mouse');
}
};
let onMouseUp = (e: MouseEvent) => {
// Only handle left clicks
if (e.button !== 0) {
return;
}
if (state.ignoreEmulatedMouseEvents) {
state.ignoreEmulatedMouseEvents = false;
return;
}
if (state.target && nodeContains(state.target, getEventTarget(e) as Element) && state.pointerType != null) {
// Wait for onClick to fire onPress. This avoids browser issues when the DOM
// is mutated between onMouseUp and onClick, and is more compatible with third party libraries.
if (state.isPressed && isDisabledRef.current) {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
return;
}
} else {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
}
state.isOverTarget = false;
};
pressProps.onTouchStart = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
let touch = getTouchFromEvent(e.nativeEvent);
if (!touch) {
return;
}
state.activePointerId = touch.identifier;
state.ignoreEmulatedMouseEvents = true;
state.isOverTarget = true;
state.isPressed = true;
state.target = e.currentTarget;
state.pointerType = 'touch';
if (!allowTextSelectionOnPress) {
disableTextSelection(state.target);
}
let shouldStopPropagation = triggerPressStart(createTouchEvent(state.target, e), state.pointerType);
if (shouldStopPropagation) {
e.stopPropagation();
}
addGlobalListener(getOwnerWindow(e.currentTarget), 'scroll', onScroll, true);
};
pressProps.onTouchMove = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
if (!state.isPressed) {
e.stopPropagation();
return;
}
let touch = getTouchById(e.nativeEvent, state.activePointerId);
let shouldStopPropagation = true;
if (touch && isOverTarget(touch, e.currentTarget)) {
if (!state.isOverTarget && state.pointerType != null) {
state.isOverTarget = true;
shouldStopPropagation = triggerPressStart(createTouchEvent(state.target!, e), state.pointerType);
}
} else if (state.isOverTarget && state.pointerType != null) {
state.isOverTarget = false;
// eslint-disable-next-line react-hooks/rules-of-hooks
shouldStopPropagation = triggerPressEndEvent(createTouchEvent(state.target!, e), state.pointerType, false);
cancelOnPointerExit(createTouchEvent(state.target!, e));
}
if (shouldStopPropagation) {
e.stopPropagation();
}
};
pressProps.onTouchEnd = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
if (!state.isPressed) {
e.stopPropagation();
return;
}
let touch = getTouchById(e.nativeEvent, state.activePointerId);
let shouldStopPropagation = true;
if (touch && isOverTarget(touch, e.currentTarget) && state.pointerType != null) {
// eslint-disable-next-line react-hooks/rules-of-hooks
triggerPressUpEvent(createTouchEvent(state.target!, e), state.pointerType);
// eslint-disable-next-line react-hooks/rules-of-hooks
shouldStopPropagation = triggerPressEndEvent(createTouchEvent(state.target!, e), state.pointerType);
triggerSyntheticClick(e.nativeEvent, state.target!);
} else if (state.isOverTarget && state.pointerType != null) {
// eslint-disable-next-line react-hooks/rules-of-hooks
shouldStopPropagation = triggerPressEndEvent(createTouchEvent(state.target!, e), state.pointerType, false);
}
if (shouldStopPropagation) {
e.stopPropagation();
}
state.isPressed = false;
state.activePointerId = null;
state.isOverTarget = false;
state.ignoreEmulatedMouseEvents = true;
if (state.target && !allowTextSelectionOnPress) {
restoreTextSelection(state.target);
}
removeAllGlobalListeners();
};
pressProps.onTouchCancel = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
e.stopPropagation();
if (state.isPressed) {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(createTouchEvent(state.target!, e));
}
};
let onScroll = (e: Event) => {
if (state.isPressed && nodeContains(getEventTarget(e) as Element, state.target)) {
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent({
currentTarget: state.target,
shiftKey: false,
ctrlKey: false,
metaKey: false,
altKey: false
});
}
};
pressProps.onDragStart = (e) => {
if (!nodeContains(e.currentTarget, getEventTarget(e))) {
return;
}
// eslint-disable-next-line react-hooks/rules-of-hooks
cancelEvent(e);
};
}
return pressProps;
}, [
addGlobalListener,
isDisabled,
preventFocusOnPress,
removeAllGlobalListeners,
allowTextSelectionOnPress,
cancelOnPointerExit,
triggerPressStart,
triggerClick,
triggerSyntheticClick
]);
// Avoid onClick delay for double tap to zoom by default.
useEffect(() => {
if (!domRef || process.env.NODE_ENV === 'test') {
return;
}
const ownerDocument = getOwnerDocument(domRef.current);
if (!ownerDocument || !ownerDocument.head || ownerDocument.getElementById(STYLE_ID)) {
return;
}
const style = ownerDocument.createElement('style');
style.id = STYLE_ID;
let nonce = getNonce(ownerDocument);
if (nonce) {
style.nonce = nonce;
}
// touchAction: 'manipulation' is supposed to be equivalent, but in
// Safari it causes onPointerCancel not to fire on scroll.
// https://bugs.webkit.org/show_bug.cgi?id=240917
style.textContent = `
@layer {
[${PRESSABLE_ATTRIBUTE}] {
touch-action: pan-x pan-y pinch-zoom;
}
}
`.trim();
ownerDocument.head.prepend(style);
}, [domRef]);
// Remove user-select: none in case component unmounts immediately after pressStart
useEffect(() => {
let state = ref.current;
return () => {
if (!allowTextSelectionOnPress) {
restoreTextSelection(state.target ?? undefined);
}
for (let dispose of state.disposables) {
dispose();
}
state.disposables = [];
};
}, [allowTextSelectionOnPress]);
return {
isPressed: isPressedProp || isPressed,
pressProps: mergeProps(domProps, pressProps, {[PRESSABLE_ATTRIBUTE]: true})
};
}
function isHTMLAnchorLink(target: Element): target is HTMLAnchorElement {
return target.tagName === 'A' && target.hasAttribute('href');
}
function isValidKeyboardEvent(event: KeyboardEvent | globalThis.KeyboardEvent, currentTarget: Element): boolean {
const {key, code} = event;
const element = currentTarget as HTMLElement;
const role = element.getAttribute('role');
// Accessibility for keyboards. Space and Enter only.
// "Spacebar" is for IE 11
return (
(key === 'Enter' || key === ' ' || key === 'Spacebar' || code === 'Space') &&
!((element instanceof getOwnerWindow(element).HTMLInputElement && !isValidInputKey(element, key)) ||
element instanceof getOwnerWindow(element).HTMLTextAreaElement ||
element.isContentEditable) &&
// Links should only trigger with Enter key
!((role === 'link' || (!role && isHTMLAnchorLink(element))) && key !== 'Enter')
);
}
function getTouchFromEvent(event: TouchEvent): Touch | null {
const {targetTouches} = event;
if (targetTouches.length > 0) {
return targetTouches[0];
}
return null;
}
function getTouchById(
event: TouchEvent,
pointerId: null | number
): null | Touch {
const changedTouches = event.changedTouches;
for (let i = 0; i < changedTouches.length; i++) {
const touch = changedTouches[i];
if (touch.identifier === pointerId) {
return touch;
}
}
return null;
}
function createTouchEvent(target: FocusableElement, e: RTouchEvent<FocusableElement>): EventBase {
let clientX = 0;
let clientY = 0;
if (e.targetTouches && e.targetTouches.length === 1) {
clientX = e.targetTouches[0].clientX;
clientY = e.targetTouches[0].clientY;
}
return {
currentTarget: target,
shiftKey: e.shiftKey,
ctrlKey: e.ctrlKey,
metaKey: e.metaKey,
altKey: e.altKey,
clientX,
clientY
};
}
function createEvent(target: FocusableElement, e: EventBase): EventBase {
let clientX = e.clientX;
let clientY = e.clientY;
return {
currentTarget: target,
shiftKey: e.shiftKey,
ctrlKey: e.ctrlKey,
metaKey: e.metaKey,
altKey: e.altKey,
clientX,
clientY,
key: e.key
};
}
interface Rect {
top: number,
right: number,
bottom: number,
left: number
}
interface EventPoint {
clientX: number,
clientY: number,
width?: number,