@tamagui/react-native-use-pressable 1.88.13 → 1.89.0-1706308641099
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.
- package/LICENSE +21 -0
- package/dist/esm/PressResponder.mjs +247 -0
- package/dist/esm/index.mjs +13 -0
- package/package.json +2 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Nate Wienert
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
const DELAY = "DELAY",
|
|
2
|
+
ERROR = "ERROR",
|
|
3
|
+
LONG_PRESS_DETECTED = "LONG_PRESS_DETECTED",
|
|
4
|
+
NOT_RESPONDER = "NOT_RESPONDER",
|
|
5
|
+
RESPONDER_ACTIVE_LONG_PRESS_START = "RESPONDER_ACTIVE_LONG_PRESS_START",
|
|
6
|
+
RESPONDER_ACTIVE_PRESS_START = "RESPONDER_ACTIVE_PRESS_START",
|
|
7
|
+
RESPONDER_INACTIVE_PRESS_START = "RESPONDER_INACTIVE_PRESS_START",
|
|
8
|
+
RESPONDER_GRANT = "RESPONDER_GRANT",
|
|
9
|
+
RESPONDER_RELEASE = "RESPONDER_RELEASE",
|
|
10
|
+
RESPONDER_TERMINATED = "RESPONDER_TERMINATED",
|
|
11
|
+
Transitions = Object.freeze({
|
|
12
|
+
NOT_RESPONDER: {
|
|
13
|
+
DELAY: ERROR,
|
|
14
|
+
RESPONDER_GRANT: RESPONDER_INACTIVE_PRESS_START,
|
|
15
|
+
RESPONDER_RELEASE: ERROR,
|
|
16
|
+
RESPONDER_TERMINATED: ERROR,
|
|
17
|
+
LONG_PRESS_DETECTED: ERROR
|
|
18
|
+
},
|
|
19
|
+
RESPONDER_INACTIVE_PRESS_START: {
|
|
20
|
+
DELAY: RESPONDER_ACTIVE_PRESS_START,
|
|
21
|
+
RESPONDER_GRANT: ERROR,
|
|
22
|
+
RESPONDER_RELEASE: NOT_RESPONDER,
|
|
23
|
+
RESPONDER_TERMINATED: NOT_RESPONDER,
|
|
24
|
+
LONG_PRESS_DETECTED: ERROR
|
|
25
|
+
},
|
|
26
|
+
RESPONDER_ACTIVE_PRESS_START: {
|
|
27
|
+
DELAY: ERROR,
|
|
28
|
+
RESPONDER_GRANT: ERROR,
|
|
29
|
+
RESPONDER_RELEASE: NOT_RESPONDER,
|
|
30
|
+
RESPONDER_TERMINATED: NOT_RESPONDER,
|
|
31
|
+
LONG_PRESS_DETECTED: RESPONDER_ACTIVE_LONG_PRESS_START
|
|
32
|
+
},
|
|
33
|
+
RESPONDER_ACTIVE_LONG_PRESS_START: {
|
|
34
|
+
DELAY: ERROR,
|
|
35
|
+
RESPONDER_GRANT: ERROR,
|
|
36
|
+
RESPONDER_RELEASE: NOT_RESPONDER,
|
|
37
|
+
RESPONDER_TERMINATED: NOT_RESPONDER,
|
|
38
|
+
LONG_PRESS_DETECTED: RESPONDER_ACTIVE_LONG_PRESS_START
|
|
39
|
+
},
|
|
40
|
+
ERROR: {
|
|
41
|
+
DELAY: NOT_RESPONDER,
|
|
42
|
+
RESPONDER_GRANT: RESPONDER_INACTIVE_PRESS_START,
|
|
43
|
+
RESPONDER_RELEASE: NOT_RESPONDER,
|
|
44
|
+
RESPONDER_TERMINATED: NOT_RESPONDER,
|
|
45
|
+
LONG_PRESS_DETECTED: NOT_RESPONDER
|
|
46
|
+
}
|
|
47
|
+
}),
|
|
48
|
+
isActiveSignal = signal => signal === RESPONDER_ACTIVE_PRESS_START || signal === RESPONDER_ACTIVE_LONG_PRESS_START,
|
|
49
|
+
isButtonRole = element => element.getAttribute("role") === "button",
|
|
50
|
+
isPressStartSignal = signal => signal === RESPONDER_INACTIVE_PRESS_START || signal === RESPONDER_ACTIVE_PRESS_START || signal === RESPONDER_ACTIVE_LONG_PRESS_START,
|
|
51
|
+
isTerminalSignal = signal => signal === RESPONDER_TERMINATED || signal === RESPONDER_RELEASE,
|
|
52
|
+
isValidKeyPress = event => {
|
|
53
|
+
const key = event.key,
|
|
54
|
+
role = event.target.getAttribute("role");
|
|
55
|
+
return key === "Enter" || (key === " " || key === "Spacebar") && role === "button";
|
|
56
|
+
},
|
|
57
|
+
DEFAULT_LONG_PRESS_DELAY_MS = 450,
|
|
58
|
+
DEFAULT_PRESS_DELAY_MS = 50;
|
|
59
|
+
class PressResponder {
|
|
60
|
+
_touchActivatePosition = null;
|
|
61
|
+
_pressDelayTimeout = 0;
|
|
62
|
+
_selectionTerminated = !1;
|
|
63
|
+
_isPointerTouch = !1;
|
|
64
|
+
_longPressDelayTimeout = 0;
|
|
65
|
+
_longPressDispatched = !1;
|
|
66
|
+
_pressOutDelayTimeout = 0;
|
|
67
|
+
_touchState = NOT_RESPONDER;
|
|
68
|
+
_config = null;
|
|
69
|
+
_eventHandlers = null;
|
|
70
|
+
constructor(config) {
|
|
71
|
+
this.configure(config);
|
|
72
|
+
}
|
|
73
|
+
configure(config) {
|
|
74
|
+
this._config = config;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Resets any pending timers. This should be called on unmount.
|
|
78
|
+
*/
|
|
79
|
+
reset() {
|
|
80
|
+
this._cancelLongPressDelayTimeout(), this._cancelPressDelayTimeout(), this._cancelPressOutDelayTimeout();
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Returns a set of props to spread into the interactive element.
|
|
84
|
+
*/
|
|
85
|
+
getEventHandlers() {
|
|
86
|
+
return this._eventHandlers == null && (this._eventHandlers = this._createEventHandlers()), this._eventHandlers;
|
|
87
|
+
}
|
|
88
|
+
_createEventHandlers() {
|
|
89
|
+
const start = (event, shouldDelay) => {
|
|
90
|
+
event.persist(), this._cancelPressOutDelayTimeout(), this._longPressDispatched = !1, this._selectionTerminated = !1, this._touchState = NOT_RESPONDER, this._isPointerTouch = event.nativeEvent.type === "touchstart", this._receiveSignal(RESPONDER_GRANT, event);
|
|
91
|
+
const delayPressStart = normalizeDelay(this._config.delayPressStart, 0, DEFAULT_PRESS_DELAY_MS);
|
|
92
|
+
shouldDelay !== !1 && delayPressStart > 0 ? this._pressDelayTimeout = setTimeout(() => {
|
|
93
|
+
this._receiveSignal(DELAY, event);
|
|
94
|
+
}, delayPressStart) : this._receiveSignal(DELAY, event);
|
|
95
|
+
const delayLongPress = normalizeDelay(this._config.delayLongPress, 10, DEFAULT_LONG_PRESS_DELAY_MS);
|
|
96
|
+
this._longPressDelayTimeout = setTimeout(() => {
|
|
97
|
+
this._handleLongPress(event);
|
|
98
|
+
}, delayLongPress + delayPressStart);
|
|
99
|
+
},
|
|
100
|
+
end = event => {
|
|
101
|
+
this._receiveSignal(RESPONDER_RELEASE, event);
|
|
102
|
+
},
|
|
103
|
+
keyupHandler = event => {
|
|
104
|
+
const onPress = this._config.onPress,
|
|
105
|
+
target = event.target;
|
|
106
|
+
if (this._touchState !== NOT_RESPONDER && isValidKeyPress(event)) {
|
|
107
|
+
end(event), document.removeEventListener("keyup", keyupHandler);
|
|
108
|
+
const role = target.getAttribute("role"),
|
|
109
|
+
elementType = target.tagName.toLowerCase(),
|
|
110
|
+
isNativeInteractiveElement = role === "link" || elementType === "a" || elementType === "button" || elementType === "input" || elementType === "select" || elementType === "textarea";
|
|
111
|
+
onPress != null && !isNativeInteractiveElement && onPress(event);
|
|
112
|
+
}
|
|
113
|
+
};
|
|
114
|
+
return {
|
|
115
|
+
onStartShouldSetResponder: event => {
|
|
116
|
+
const disabled = this._config.disabled;
|
|
117
|
+
return disabled && isButtonRole(event.currentTarget) && event.stopPropagation(), disabled == null ? !0 : !disabled;
|
|
118
|
+
},
|
|
119
|
+
onKeyDown: event => {
|
|
120
|
+
const disabled = this._config.disabled,
|
|
121
|
+
key = event.key,
|
|
122
|
+
target = event.target;
|
|
123
|
+
if (!disabled && isValidKeyPress(event)) {
|
|
124
|
+
this._touchState === NOT_RESPONDER && (start(event, !1), document.addEventListener("keyup", keyupHandler));
|
|
125
|
+
const role = target.getAttribute("role");
|
|
126
|
+
(key === " " || key === "Spacebar") && (role === "button" || role === "menuitem") && event.preventDefault(), event.stopPropagation();
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
onResponderGrant: event => start(event),
|
|
130
|
+
onResponderMove: event => {
|
|
131
|
+
this._config.onPressMove != null && this._config.onPressMove(event);
|
|
132
|
+
const touch = getTouchFromResponderEvent(event);
|
|
133
|
+
if (this._touchActivatePosition != null) {
|
|
134
|
+
const deltaX = this._touchActivatePosition.pageX - touch.pageX,
|
|
135
|
+
deltaY = this._touchActivatePosition.pageY - touch.pageY;
|
|
136
|
+
Math.hypot(deltaX, deltaY) > 10 && this._cancelLongPressDelayTimeout();
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
onResponderRelease: event => end(event),
|
|
140
|
+
onResponderTerminate: event => {
|
|
141
|
+
event.nativeEvent.type === "selectionchange" && (this._selectionTerminated = !0), this._receiveSignal(RESPONDER_TERMINATED, event);
|
|
142
|
+
},
|
|
143
|
+
onResponderTerminationRequest: event => {
|
|
144
|
+
const _this$_config = this._config,
|
|
145
|
+
cancelable = _this$_config.cancelable,
|
|
146
|
+
disabled = _this$_config.disabled,
|
|
147
|
+
onLongPress = _this$_config.onLongPress;
|
|
148
|
+
return !disabled && onLongPress != null && this._isPointerTouch && event.nativeEvent.type === "contextmenu" ? !1 : cancelable ?? !0;
|
|
149
|
+
},
|
|
150
|
+
// NOTE: this diverges from react-native in 3 significant ways:
|
|
151
|
+
// * The `onPress` callback is not connected to the responder system (the native
|
|
152
|
+
// `click` event must be used but is dispatched in many scenarios where no pointers
|
|
153
|
+
// are on the screen.) Therefore, it's possible for `onPress` to be called without
|
|
154
|
+
// `onPress{Start,End}` being called first.
|
|
155
|
+
// * The `onPress` callback is only be called on the first ancestor of the native
|
|
156
|
+
// `click` target that is using the PressResponder.
|
|
157
|
+
// * The event's `nativeEvent` is a `MouseEvent` not a `TouchEvent`.
|
|
158
|
+
onClick: event => {
|
|
159
|
+
const _this$_config2 = this._config,
|
|
160
|
+
disabled = _this$_config2.disabled,
|
|
161
|
+
onPress = _this$_config2.onPress;
|
|
162
|
+
disabled ? isButtonRole(event.currentTarget) && event.stopPropagation() : (event.stopPropagation(), this._longPressDispatched || this._selectionTerminated ? event.preventDefault() : onPress != null && event.altKey === !1 && onPress(event));
|
|
163
|
+
},
|
|
164
|
+
// If `onLongPress` is provided and a touch pointer is being used, prevent the
|
|
165
|
+
// default context menu from opening.
|
|
166
|
+
onContextMenu: event => {
|
|
167
|
+
const _this$_config3 = this._config,
|
|
168
|
+
disabled = _this$_config3.disabled,
|
|
169
|
+
onLongPress = _this$_config3.onLongPress;
|
|
170
|
+
disabled ? isButtonRole(event.currentTarget) && event.stopPropagation() : onLongPress != null && this._isPointerTouch && !event.defaultPrevented && (event.preventDefault(), event.stopPropagation());
|
|
171
|
+
}
|
|
172
|
+
};
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Receives a state machine signal, performs side effects of the transition
|
|
176
|
+
* and stores the new state. Validates the transition as well.
|
|
177
|
+
*/
|
|
178
|
+
_receiveSignal(signal, event) {
|
|
179
|
+
const prevState = this._touchState;
|
|
180
|
+
let nextState = null;
|
|
181
|
+
Transitions[prevState] != null && (nextState = Transitions[prevState][signal]), !(this._touchState === NOT_RESPONDER && signal === RESPONDER_RELEASE) && (nextState == null || nextState === ERROR ? console.error(`PressResponder: Invalid signal ${signal} for state ${prevState} on responder`) : prevState !== nextState && (this._performTransitionSideEffects(prevState, nextState, signal, event), this._touchState = nextState));
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Performs a transition between touchable states and identify any activations
|
|
185
|
+
* or deactivations (and callback invocations).
|
|
186
|
+
*/
|
|
187
|
+
_performTransitionSideEffects(prevState, nextState, signal, event) {
|
|
188
|
+
if (isTerminalSignal(signal) && (setTimeout(() => {
|
|
189
|
+
this._isPointerTouch = !1;
|
|
190
|
+
}, 0), this._touchActivatePosition = null, this._cancelLongPressDelayTimeout()), isPressStartSignal(prevState) && signal === LONG_PRESS_DETECTED) {
|
|
191
|
+
const onLongPress = this._config.onLongPress;
|
|
192
|
+
onLongPress != null && event.nativeEvent.key == null && (onLongPress(event), this._longPressDispatched = !0);
|
|
193
|
+
}
|
|
194
|
+
const isPrevActive = isActiveSignal(prevState),
|
|
195
|
+
isNextActive = isActiveSignal(nextState);
|
|
196
|
+
if (!isPrevActive && isNextActive ? this._activate(event) : isPrevActive && !isNextActive && this._deactivate(event), isPressStartSignal(prevState) && signal === RESPONDER_RELEASE) {
|
|
197
|
+
const _this$_config4 = this._config,
|
|
198
|
+
_onLongPress = _this$_config4.onLongPress;
|
|
199
|
+
_this$_config4.onPress != null && (_onLongPress != null && prevState === RESPONDER_ACTIVE_LONG_PRESS_START || isNextActive || isPrevActive || (this._activate(event), this._deactivate(event)));
|
|
200
|
+
}
|
|
201
|
+
this._cancelPressDelayTimeout();
|
|
202
|
+
}
|
|
203
|
+
_activate(event) {
|
|
204
|
+
const _this$_config5 = this._config,
|
|
205
|
+
onPressChange = _this$_config5.onPressChange,
|
|
206
|
+
onPressStart = _this$_config5.onPressStart,
|
|
207
|
+
touch = getTouchFromResponderEvent(event);
|
|
208
|
+
this._touchActivatePosition = {
|
|
209
|
+
pageX: touch.pageX,
|
|
210
|
+
pageY: touch.pageY
|
|
211
|
+
}, onPressStart?.(event), onPressChange?.(!0);
|
|
212
|
+
}
|
|
213
|
+
_deactivate(event) {
|
|
214
|
+
const _this$_config6 = this._config,
|
|
215
|
+
onPressChange = _this$_config6.onPressChange,
|
|
216
|
+
onPressEnd = _this$_config6.onPressEnd;
|
|
217
|
+
function end() {
|
|
218
|
+
onPressEnd?.(event), onPressChange?.(!1);
|
|
219
|
+
}
|
|
220
|
+
const delayPressEnd = normalizeDelay(this._config.delayPressEnd);
|
|
221
|
+
delayPressEnd > 0 ? this._pressOutDelayTimeout = setTimeout(() => {
|
|
222
|
+
end();
|
|
223
|
+
}, delayPressEnd) : end();
|
|
224
|
+
}
|
|
225
|
+
_handleLongPress(event) {
|
|
226
|
+
(this._touchState === RESPONDER_ACTIVE_PRESS_START || this._touchState === RESPONDER_ACTIVE_LONG_PRESS_START) && this._receiveSignal(LONG_PRESS_DETECTED, event);
|
|
227
|
+
}
|
|
228
|
+
_cancelLongPressDelayTimeout() {
|
|
229
|
+
this._longPressDelayTimeout != null && (clearTimeout(this._longPressDelayTimeout), this._longPressDelayTimeout = null);
|
|
230
|
+
}
|
|
231
|
+
_cancelPressDelayTimeout() {
|
|
232
|
+
this._pressDelayTimeout != null && (clearTimeout(this._pressDelayTimeout), this._pressDelayTimeout = null);
|
|
233
|
+
}
|
|
234
|
+
_cancelPressOutDelayTimeout() {
|
|
235
|
+
this._pressOutDelayTimeout != null && (clearTimeout(this._pressOutDelayTimeout), this._pressOutDelayTimeout = null);
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
function normalizeDelay(delay, min, fallback) {
|
|
239
|
+
return min === void 0 && (min = 0), fallback === void 0 && (fallback = 0), Math.max(min, delay ?? fallback);
|
|
240
|
+
}
|
|
241
|
+
function getTouchFromResponderEvent(event) {
|
|
242
|
+
const _event$nativeEvent = event.nativeEvent,
|
|
243
|
+
changedTouches = _event$nativeEvent.changedTouches,
|
|
244
|
+
touches = _event$nativeEvent.touches;
|
|
245
|
+
return touches != null && touches.length > 0 ? touches[0] : changedTouches != null && changedTouches.length > 0 ? changedTouches[0] : event.nativeEvent;
|
|
246
|
+
}
|
|
247
|
+
export { PressResponder as default };
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { useDebugValue, useEffect, useRef } from "react";
|
|
2
|
+
import PressResponder from "./PressResponder.mjs";
|
|
3
|
+
function usePressEvents(_, config) {
|
|
4
|
+
const pressResponderRef = useRef(null);
|
|
5
|
+
pressResponderRef.current == null && (pressResponderRef.current = new PressResponder(config));
|
|
6
|
+
const pressResponder = pressResponderRef.current;
|
|
7
|
+
return useEffect(() => {
|
|
8
|
+
pressResponder.configure(config);
|
|
9
|
+
}, [config, pressResponder]), useEffect(() => () => {
|
|
10
|
+
pressResponder.reset();
|
|
11
|
+
}, [pressResponder]), useDebugValue(config), pressResponder.getEventHandlers();
|
|
12
|
+
}
|
|
13
|
+
export { usePressEvents };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tamagui/react-native-use-pressable",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.89.0-1706308641099",
|
|
4
4
|
"types": "./types/index.d.ts",
|
|
5
5
|
"main": "dist/cjs",
|
|
6
6
|
"module": "dist/esm",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"react": "*"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
|
-
"@tamagui/build": "1.
|
|
33
|
+
"@tamagui/build": "1.89.0-1706308641099",
|
|
34
34
|
"react": "^18.2.0"
|
|
35
35
|
},
|
|
36
36
|
"publishConfig": {
|