-
Notifications
You must be signed in to change notification settings - Fork 0
/
long-press-event.js
312 lines (259 loc) · 11.1 KB
/
long-press-event.js
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
/*!
* long-press-event - v@version@
* Pure JavaScript long-press-event
* https://github.com/john-doherty/long-press-event
* @author John Doherty <www.johndoherty.info>
* @license MIT
*/
(function (window, document) {
'use strict';
// local timer object based on rAF
var timer = null;
// check if we're using a touch screen
var hasPointerEvents = (('PointerEvent' in window) || (window.navigator && 'msPointerEnabled' in window.navigator));
var isTouch = (('ontouchstart' in window) || (navigator.MaxTouchPoints > 0) || (navigator.msMaxTouchPoints > 0));
// switch to pointer events or touch events if using a touch screen
var mouseDown = hasPointerEvents ? 'pointerdown' : isTouch ? 'touchstart' : 'mousedown';
var mouseUp = hasPointerEvents ? 'pointerup' : isTouch ? 'touchend' : 'mouseup';
var mouseMove = hasPointerEvents ? 'pointermove' : isTouch ? 'touchmove' : 'mousemove';
var mouseLeave = hasPointerEvents ? 'pointerleave' : isTouch ? 'touchleave' : 'mouseleave';
// track number of pixels the mouse moves during long press
var startX = 0; // mouse x position when timer started
var startY = 0; // mouse y position when timer started
var maxDiffX = 10; // max number of X pixels the mouse can move during long press before it is canceled
var maxDiffY = 10; // max number of Y pixels the mouse can move during long press before it is canceled
var longPressedEl = null;
// patch CustomEvent to allow constructor creation (IE/Chrome)
if (typeof window.CustomEvent !== 'function') {
window.CustomEvent = function (event, params) {
params = params || {
bubbles: false,
cancelable: false,
detail: undefined
};
var evt = document.createEvent('CustomEvent');
evt.initCustomEvent(event, params.bubbles, params.cancelable, params.detail);
return evt;
};
window.CustomEvent.prototype = window.Event.prototype;
}
// requestAnimationFrame() shim by Paul Irish
window.requestAnimFrame = (function () {
return window.requestAnimationFrame ||
window.webkitRequestAnimationFrame ||
window.mozRequestAnimationFrame ||
window.oRequestAnimationFrame ||
window.msRequestAnimationFrame || function (callback) {
window.setTimeout(callback, 1000 / 60);
};
})();
/**
* Behaves the same as setTimeout except uses requestAnimationFrame() where possible for better performance
* @param {function} fn The callback function
* @param {int} delay The delay in milliseconds
* @returns {object} handle to the timeout object
*/
function requestTimeout(fn, delay) {
if (!window.requestAnimationFrame && !window.webkitRequestAnimationFrame &&
!(window.mozRequestAnimationFrame && window.mozCancelRequestAnimationFrame) && // Firefox 5 ships without cancel support
!window.oRequestAnimationFrame && !window.msRequestAnimationFrame) return window.setTimeout(fn, delay);
var start = new Date().getTime();
var handle = {};
var loop = function () {
var current = new Date().getTime();
var delta = current - start;
if (delta >= delay) {
fn.call();
} else {
handle.value = requestAnimFrame(loop);
}
};
handle.value = requestAnimFrame(loop);
return handle;
}
/**
* Behaves the same as clearTimeout except uses cancelRequestAnimationFrame() where possible for better performance
* @param {object} handle The callback function
* @returns {void}
*/
function clearRequestTimeout(handle) {
if (handle) {
window.cancelAnimationFrame ? window.cancelAnimationFrame(handle.value) :
window.webkitCancelAnimationFrame ? window.webkitCancelAnimationFrame(handle.value) :
window.webkitCancelRequestAnimationFrame ? window.webkitCancelRequestAnimationFrame(handle.value) : /* Support for legacy API */
window.mozCancelRequestAnimationFrame ? window.mozCancelRequestAnimationFrame(handle.value) :
window.oCancelRequestAnimationFrame ? window.oCancelRequestAnimationFrame(handle.value) :
window.msCancelRequestAnimationFrame ? window.msCancelRequestAnimationFrame(handle.value) :
clearTimeout(handle);
}
}
/**
* Fires the 'long-press' event on element
* @param {MouseEvent|PointerEvent|TouchEvent} originalEvent The original event being fired
* @returns {void}
*/
function fireLongPressEvent(originalEvent) {
clearLongPressTimer();
longPressedEl = this;
originalEvent = unifyEvent(originalEvent);
// fire the long-press event
var allowClickEvent = this.dispatchEvent(new CustomEvent('long-press', {
bubbles: true,
cancelable: true,
// custom event data (legacy)
detail: {
clientX: originalEvent.clientX,
clientY: originalEvent.clientY
},
// add coordinate data that would typically acompany a touch/click event
clientX: originalEvent.clientX,
clientY: originalEvent.clientY,
offsetX: originalEvent.offsetX,
offsetY: originalEvent.offsetY,
pageX: originalEvent.pageX,
pageY: originalEvent.pageY,
screenX: originalEvent.screenX,
screenY: originalEvent.screenY
}));
if (!allowClickEvent) {
// suppress the next click event if e.preventDefault() was called in long-press handler
var suppressClickEvent = function suppressCLickEvent(e) {
document.removeEventListener('click', suppressClickEvent, true);
cancelEvent(e);
};
document.addEventListener('click', suppressClickEvent, true);
document.addEventListener(mouseDown, function suppressEvents(e) {
document.removeEventListener(mouseDown, suppressEvents, true);
document.removeEventListener('click', suppressClickEvent, true);
}, true);
}
this.addEventListener(mouseLeave, clearLongPressTimer, true);
}
/**
* Fires the 'long-press-end' event on element
* @param {MouseEvent|PointerEvent|TouchEvent} originalEvent The original event being fired
* @returns {void}
*/
function fireLongPressEndEvent(originalEvent) {
//longPressedEl.removeEventListener(mouseLeave, clearLongPressTimer, true);
longPressedEl = null;
originalEvent = unifyEvent(originalEvent);
// fire the long-press event
this.dispatchEvent(new CustomEvent('long-press-end', {
bubbles: true,
cancelable: true,
// custom event data (legacy)
detail: {
clientX: originalEvent.clientX,
clientY: originalEvent.clientY
},
// add coordinate data that would typically acompany a touch/click event
clientX: originalEvent.clientX,
clientY: originalEvent.clientY,
offsetX: originalEvent.offsetX,
offsetY: originalEvent.offsetY,
pageX: originalEvent.pageX,
pageY: originalEvent.pageY,
screenX: originalEvent.screenX,
screenY: originalEvent.screenY
}));
}
/**
* consolidates mouse, touch, and Pointer events
* @param {MouseEvent|PointerEvent|TouchEvent} e The original event being fired
* @returns {MouseEvent|PointerEvent|Touch}
*/
function unifyEvent(e) {
if (e.changedTouches !== undefined) {
return e.changedTouches[0];
}
return e;
}
/**
* method responsible for starting the long press timer
* @param {event} e - event object
* @returns {void}
*/
function startLongPressTimer(e) {
clearLongPressTimer(e);
var el = e.target;
// get delay from html attribute if it exists, otherwise default to 1500
var longPressDelayInMs = parseInt(getNearestAttribute(el, 'data-long-press-delay', '1500'), 10); // default 1500
// start the timer
timer = requestTimeout(fireLongPressEvent.bind(el, e), longPressDelayInMs);
}
/**
* method responsible for clearing a pending long press timer
* @param {event} e - event object
* @returns {void}
*/
function clearLongPressTimer(e) {
if (longPressedEl !== null) {
longPressedEl.removeEventListener(mouseLeave, clearLongPressTimer, true);
var fn = fireLongPressEndEvent.bind(longPressedEl, e);
fn();
}
longPressedEl = null;
clearRequestTimeout(timer);
timer = null;
}
/**
* Cancels the current event
* @param {object} e - browser event object
* @returns {void}
*/
function cancelEvent(e) {
e.stopImmediatePropagation();
e.preventDefault();
e.stopPropagation();
}
/**
* Starts the timer on mouse down and logs current position
* @param {object} e - browser event object
* @returns {void}
*/
function mouseDownHandler(e) {
startX = e.clientX;
startY = e.clientY;
startLongPressTimer(e);
}
/**
* If the mouse moves n pixels during long-press, cancel the timer
* @param {object} e - browser event object
* @returns {void}
*/
function mouseMoveHandler(e) {
// calculate total number of pixels the pointer has moved
var diffX = Math.abs(startX - e.clientX);
var diffY = Math.abs(startY - e.clientY);
// if pointer has moved more than allowed, cancel the long-press timer and therefore the event
if (diffX >= maxDiffX || diffY >= maxDiffY) {
clearLongPressTimer(e);
}
}
/**
* Gets attribute off HTML element or nearest parent
* @param {object} el - HTML element to retrieve attribute from
* @param {string} attributeName - name of the attribute
* @param {any} defaultValue - default value to return if no match found
* @returns {any} attribute value or defaultValue
*/
function getNearestAttribute(el, attributeName, defaultValue) {
// walk up the dom tree looking for data-action and data-trigger
while (el && el !== document.documentElement) {
var attributeValue = el.getAttribute(attributeName);
if (attributeValue) {
return attributeValue;
}
el = el.parentNode;
}
return defaultValue;
}
// hook events that clear a pending long press event
document.addEventListener(mouseUp, clearLongPressTimer, true);
document.addEventListener(mouseMove, mouseMoveHandler, true);
document.addEventListener('wheel', clearLongPressTimer, true);
document.addEventListener('scroll', clearLongPressTimer, true);
// hook events that can trigger a long press event
document.addEventListener(mouseDown, mouseDownHandler, true); // <- start
}(window, document));