Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Commit

Permalink
feat($swipe): Refactor swipe logic from ngSwipe to $swipe service.
Browse files Browse the repository at this point in the history
This new service is used by the ngSwipeLeft/Right directives, and by the
separate ngCarousel and swipe-to-delete directives which are under
development.
  • Loading branch information
bshepherdson authored and jeffbcross committed May 23, 2013
1 parent 05772e1 commit f4c6b2c
Show file tree
Hide file tree
Showing 5 changed files with 437 additions and 79 deletions.
1 change: 1 addition & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ module.exports = function(grunt) {
dest: 'build/angular-mobile.js',
src: util.wrap([
'src/ngMobile/mobile.js',
'src/ngMobile/swipe.js',
'src/ngMobile/directive/ngClick.js',
'src/ngMobile/directive/ngSwipe.js'
], 'module')
Expand Down
5 changes: 4 additions & 1 deletion angularFiles.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ angularFiles = {
'src/ngSanitize/filter/linky.js',
'src/ngMock/angular-mocks.js',
'src/ngMobile/mobile.js',
'src/ngMobile/swipe.js',
'src/ngMobile/directive/ngClick.js',
'src/ngMobile/directive/ngSwipe.js',

Expand Down Expand Up @@ -113,6 +114,7 @@ angularFiles = {
'test/ngSanitize/directive/*.js',
'test/ngSanitize/filter/*.js',
'test/ngMock/*.js',
'test/ngMobile/*.js',
'test/ngMobile/directive/*.js',
'docs/component-spec/bootstrap/*.js',
'docs/component-spec/*.js'
Expand Down Expand Up @@ -154,6 +156,7 @@ angularFiles = {
'src/ngCookies/cookies.js',
'src/ngResource/resource.js',
'src/ngMobile/mobile.js',
'src/ngMobile/swipe.js',
'src/ngMobile/directive/ngClick.js',
'src/ngMobile/directive/ngSwipe.js',
'src/ngSanitize/sanitize.js',
Expand All @@ -168,7 +171,7 @@ angularFiles = {
'test/ngSanitize/*.js',
'test/ngSanitize/directive/*.js',
'test/ngSanitize/filter/*.js',
'test/ngMobile/directive/*.js'
'test/ngMobile/**/*.js'
],

'jstdPerf': [
Expand Down
94 changes: 16 additions & 78 deletions src/ngMobile/directive/ngSwipe.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,36 +55,20 @@
*/

function makeSwipeDirective(directiveName, direction) {
ngMobile.directive(directiveName, ['$parse', function($parse) {
ngMobile.directive(directiveName, ['$parse', '$swipe', function($parse, $swipe) {
// The maximum vertical delta for a swipe should be less than 75px.
var MAX_VERTICAL_DISTANCE = 75;
// Vertical distance should not be more than a fraction of the horizontal distance.
var MAX_VERTICAL_RATIO = 0.3;
// At least a 30px lateral motion is necessary for a swipe.
var MIN_HORIZONTAL_DISTANCE = 30;
// The total distance in any direction before we make the call on swipe vs. scroll.
var MOVE_BUFFER_RADIUS = 10;

function getCoordinates(event) {
var touches = event.touches && event.touches.length ? event.touches : [event];
var e = (event.changedTouches && event.changedTouches[0]) ||
(event.originalEvent && event.originalEvent.changedTouches &&
event.originalEvent.changedTouches[0]) ||
touches[0].originalEvent || touches[0];

return {
x: e.clientX,
y: e.clientY
};
}

return function(scope, element, attr) {
var swipeHandler = $parse(attr[directiveName]);

var startCoords, valid;
var totalX, totalY;
var lastX, lastY;

function validSwipe(event) {
function validSwipe(coords) {
// Check that it's within the coordinates.
// Absolute vertical distance must be within tolerances.
// Horizontal distance, we take the current X - the starting X.
Expand All @@ -94,7 +78,6 @@ function makeSwipeDirective(directiveName, direction) {
// illegal ones a negative delta.
// Therefore this delta must be positive, and larger than the minimum.
if (!startCoords) return false;
var coords = getCoordinates(event);
var deltaY = Math.abs(coords.y - startCoords.y);
var deltaX = (coords.x - startCoords.x) * direction;
return valid && // Short circuit for already-invalidated swipes.
Expand All @@ -104,65 +87,20 @@ function makeSwipeDirective(directiveName, direction) {
deltaY / deltaX < MAX_VERTICAL_RATIO;
}

element.bind('touchstart mousedown', function(event) {
startCoords = getCoordinates(event);
valid = true;
totalX = 0;
totalY = 0;
lastX = startCoords.x;
lastY = startCoords.y;
});

element.bind('touchcancel', function(event) {
valid = false;
});

element.bind('touchmove mousemove', function(event) {
if (!valid) return;

// Android will send a touchcancel if it thinks we're starting to scroll.
// So when the total distance (+ or - or both) exceeds 10px in either direction,
// we either:
// - On totalX > totalY, we send preventDefault() and treat this as a swipe.
// - On totalY > totalX, we let the browser handle it as a scroll.

// Invalidate a touch while it's in progress if it strays too far away vertically.
// We don't want a scroll down and back up while drifting sideways to be a swipe just
// because you happened to end up vertically close in the end.
if (!startCoords) return;
var coords = getCoordinates(event);

if (Math.abs(coords.y - startCoords.y) > MAX_VERTICAL_DISTANCE) {
$swipe.bind(element, {
'start': function(coords) {
startCoords = coords;
valid = true;
},
'cancel': function() {
valid = false;
return;
}

totalX += Math.abs(coords.x - lastX);
totalY += Math.abs(coords.y - lastY);

lastX = coords.x;
lastY = coords.y;

if (totalX < MOVE_BUFFER_RADIUS && totalY < MOVE_BUFFER_RADIUS) {
return;
}

// One of totalX or totalY has exceeded the buffer, so decide on swipe vs. scroll.
if (totalY > totalX) {
valid = false;
return;
} else {
event.preventDefault();
}
});

element.bind('touchend mouseup', function(event) {
if (validSwipe(event)) {
// Prevent this swipe from bubbling up to any other elements with ngSwipes.
event.stopPropagation();
scope.$apply(function() {
swipeHandler(scope, {$event:event});
});
},
'end': function(coords) {
if (validSwipe(coords)) {
scope.$apply(function() {
swipeHandler(scope);
});
}
}
});
};
Expand Down
136 changes: 136 additions & 0 deletions src/ngMobile/swipe.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
'use strict';

/**
* @ngdoc object
* @name ngMobile.$swipe
*
* @description
* The `$swipe` service is a service that abstracts the messier details of hold-and-drag swipe
* behavior, to make implementing swipe-related directives more convenient.
*
* It is used by the `ngSwipeLeft` and `ngSwipeRight` directives in `ngMobile`, and by
* `ngCarousel` in a separate component.
*
* # Usage
* The `$swipe` service is an object with a single method: `bind`. `bind` takes an element
* which is to be watched for swipes, and an object with four handler functions. See the
* documentation for `bind` below.
*/

ngMobile.factory('$swipe', [function() {
// The total distance in any direction before we make the call on swipe vs. scroll.
var MOVE_BUFFER_RADIUS = 10;

function getCoordinates(event) {
var touches = event.touches && event.touches.length ? event.touches : [event];
var e = (event.changedTouches && event.changedTouches[0]) ||
(event.originalEvent && event.originalEvent.changedTouches &&
event.originalEvent.changedTouches[0]) ||
touches[0].originalEvent || touches[0];

return {
x: e.clientX,
y: e.clientY
};
}

return {
/**
* @ngdoc method
* @name ngMobile.$swipe#bind
* @methodOf ngMobile.$swipe
*
* @description
* The main method of `$swipe`. It takes an element to be watched for swipe motions, and an
* object containing event handlers.
*
* The four events are `start`, `move`, `end`, and `cancel`. `start`, `move`, and `end`
* receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }`.
*
* `start` is called on either `mousedown` or `touchstart`. After this event, `$swipe` is
* watching for `touchmove` or `mousemove` events. These events are ignored until the total
* distance moved in either dimension exceeds a small threshold.
*
* Once this threshold is exceeded, either the horizontal or vertical delta is greater.
* - If the horizontal distance is greater, this is a swipe and `move` and `end` events follow.
* - If the vertical distance is greater, this is a scroll, and we let the browser take over.
* A `cancel` event is sent.
*
* `move` is called on `mousemove` and `touchmove` after the above logic has determined that
* a swipe is in progress.
*
* `end` is called when a swipe is successfully completed with a `touchend` or `mouseup`.
*
* `cancel` is called either on a `touchcancel` from the browser, or when we begin scrolling
* as described above.
*
*/
bind: function(element, eventHandlers) {
// Absolute total movement, used to control swipe vs. scroll.
var totalX, totalY;
// Coordinates of the start position.
var startCoords;
// Last event's position.
var lastPos;
// Whether a swipe is active.
var active = false;

element.bind('touchstart mousedown', function(event) {
startCoords = getCoordinates(event);
active = true;
totalX = 0;
totalY = 0;
lastPos = startCoords;
eventHandlers['start'] && eventHandlers['start'](startCoords);
});

element.bind('touchcancel', function(event) {
active = false;
eventHandlers['cancel'] && eventHandlers['cancel']();
});

element.bind('touchmove mousemove', function(event) {
if (!active) return;

// Android will send a touchcancel if it thinks we're starting to scroll.
// So when the total distance (+ or - or both) exceeds 10px in either direction,
// we either:
// - On totalX > totalY, we send preventDefault() and treat this as a swipe.
// - On totalY > totalX, we let the browser handle it as a scroll.

if (!startCoords) return;
var coords = getCoordinates(event);

totalX += Math.abs(coords.x - lastPos.x);
totalY += Math.abs(coords.y - lastPos.y);

lastPos = coords;

if (totalX < MOVE_BUFFER_RADIUS && totalY < MOVE_BUFFER_RADIUS) {
return;
}

// One of totalX or totalY has exceeded the buffer, so decide on swipe vs. scroll.
if (totalY > totalX) {
// Allow native scrolling to take over.
active = false;
eventHandlers['cancel'] && eventHandlers['cancel']();
return;
} else {
// Prevent the browser from scrolling.
event.preventDefault();

eventHandlers['move'] && eventHandlers['move'](coords);
}
});

element.bind('touchend mouseup', function(event) {
if (!active) return;
active = false;
eventHandlers['end'] && eventHandlers['end'](getCoordinates(event));
});
}
};
}]);


Loading

0 comments on commit f4c6b2c

Please sign in to comment.