mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
4c6916d30d
Closes #1734 Coming from the documentation `$ionicGesture.off` had to be called like `$ionicGesture.off('swipe', mySwipe, myElement)`. Instead, it has to be called with the gesture returned from `$ionicGesture.on` and the type+callback to remove. I added the `@returns {ionic.Gesture} ...` to `.on` to make clear that this returns the gesture you may want to remove later on. I also made the documentation for `.off` match the function signature.
37 lines
1.4 KiB
JavaScript
37 lines
1.4 KiB
JavaScript
/**
|
|
* @ngdoc service
|
|
* @name $ionicGesture
|
|
* @module ionic
|
|
* @description An angular service exposing ionic
|
|
* {@link ionic.utility:ionic.EventController}'s gestures.
|
|
*/
|
|
IonicModule
|
|
.factory('$ionicGesture', [function() {
|
|
return {
|
|
/**
|
|
* @ngdoc method
|
|
* @name $ionicGesture#on
|
|
* @description Add an event listener for a gesture on an element. See {@link ionic.utility:ionic.EventController#onGesture}.
|
|
* @param {string} eventType The gesture event to listen for.
|
|
* @param {function(e)} callback The function to call when the gesture
|
|
* happens.
|
|
* @param {element} $element The angular element to listen for the event on.
|
|
* @returns {ionic.Gesture} The gesture object (use this to remove the gesture later on).
|
|
*/
|
|
on: function(eventType, cb, $element) {
|
|
return window.ionic.onGesture(eventType, cb, $element[0]);
|
|
},
|
|
/**
|
|
* @ngdoc method
|
|
* @name $ionicGesture#off
|
|
* @description Remove an event listener for a gesture on an element. See {@link ionic.utility:ionic.EventController#offGesture}.
|
|
* @param {ionic.Gesture} gesture The gesture that should be removed.
|
|
* @param {string} eventType The gesture event to remove the listener for.
|
|
* @param {function(e)} callback The listener to remove.
|
|
*/
|
|
off: function(gesture, eventType, cb) {
|
|
return window.ionic.offGesture(gesture, eventType, cb);
|
|
}
|
|
};
|
|
}]);
|