@react-aria/interactions 3.27.0 → 3.28.0

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