Ionic Gestures is a utility that allows developers to build custom gestures and interactions for their application in a platform agnostic manner. Developers do not need to be using a particular framework such as React or Angular, nor do they even need to be building an Ionic app! As long as developers have access to v5.0 or greater of Ionic Framework, they will have access to all of Ionic Gestures.
Building complex gestures can be time consuming. Other libraries that provide custom gestures are often times too heavy handed and end up capturing mouse or touch events and not letting them propagate. This can result in other elements no longer being scrollable or clickable.
Developers using Ionic Core and JavaScript should install the latest version of @ionic/core.
import { createGesture } from 'https://cdn.jsdelivr.net/npm/@ionic/core@latest/dist/esm/index.mjs';
...
const gesture = createGesture({
el: elementRef,
threshold: 15,
gestureName: 'my-gesture',
onMove: event => onMoveHandler(event)
});
Developers using Ionic Core and TypeScript should install the latest version of @ionic/core.
import { createGesture, Gesture } from '@ionic/core';
...
const gesture: Gesture = createGesture({
el: elementRef,
threshold: 15,
gestureName: 'my-gesture',
onMove: event => onMoveHandler(event)
});
Developers using Angular should install the latest version of @ionic/angular. Gestures can be created via the GestureController dependency injection.
By default, gesture callbacks do not run inside of NgZone. Developers can either set the runInsideAngularZone parameter to true when creating a gesture, or they can wrap their callbacks in an NgZone.run() call.
import { Gesture, GestureController } from '@ionic/angular';
...
constructor(private gestureCtrl: GestureController) {
const gesture: Gesture = this.gestureCtrl.create({
el: this.element.nativeElement,
threshold: 15,
gestureName: 'my-gesture',
onMove: event => this.onMoveHandler(event)
}, true);
}
Developers using Angular should install the latest version of @ionic/angular. Gestures can be created via the GestureController dependency injection.
By default, gesture callbacks do not run inside of NgZone. Developers can either set the runInsideAngularZone parameter to true when creating a gesture, or they can wrap their callbacks in an NgZone.run() call.
import { Gesture, GestureController } from '@ionic/angular/standalone';
...
constructor(private gestureCtrl: GestureController) {
const gesture: Gesture = this.gestureCtrl.create({
el: this.element.nativeElement,
threshold: 15,
gestureName: 'my-gesture',
onMove: event => this.onMoveHandler(event)
}, true);
}
Developers using React should install the latest version of @ionic/react. Full React wrappers are coming soon!
import { createGesture, Gesture } from '@ionic/react';
...
const gesture: Gesture = createGesture({
el: elementRef,
threshold: 15,
gestureName: 'my-gesture',
onMove: event => onMoveHandler(event)
});
Developers using Ionic Vue should install the latest version of @ionic/vue.
import { createGesture } from '@ionic/vue';
import { ref } from 'vue';
...
const elementRef = ref();
...
const gesture = createGesture({
el: elementRef.value,
threshold: 15,
gestureName: 'my-gesture',
onMove: event => onMoveHandler(event)
});
In this example, our app listens for gestures on the ion-content element. When a gesture movement has started, the onStart function is called and a class is added to our ion-card to add a colored box shadow. When a gesture movement was detected, the onMove function is called and our app prints the current gesture information within the ion-card. Finally, when a gesture movement has ended, the onEnd function is called and the custom class is removed from our ion-card.
In the example below, we want to be able to detect double clicks on an element. By setting our threshold to 0, we can ensure our gesture object can detect clicks. Additionally, we define a click threshold so that only 2 clicks that occur in quick succession count as a double click.
See our guide on implementing gesture animations: Gesture Animations with Ionic Animations
Name ValueGestureCallback (detail: GestureDetail) => boolean | void GestureConfig Property Type Default Description el Node undefined The element to listen on for gestures. disableScroll boolean | undefined false If true, scrolling will be disabled on el while the gesture is enabled. direction 'x' | 'y' | undefined 'x' Limit gesture detection to movements along a certain axis. gestureName string undefined The name of the gesture to create. gesturePriority number | undefined 0 Gestures with higher priorities will override gestures with lower priorities. Useful for ensuring the multiple gestures do not collide with one another. passive boolean | undefined true If true, this will indicate that the gesture will never call preventDefault(). This can be used to improve scrolling performance. See Passive Listeners for more information. maxAngle number | undefined 40 The maximum angle to allow when detecting a gesture. threshold number | undefined 10 Defines how much a pointer must move before the gesture starts. blurOnStart boolean | undefined undefined If true, the gesture will blur any active selectable element such as an input or a textarea before firing the onStart callback. canStart GestureCallback | undefined undefined A callback that returns true if a gesture is allowed to start. onWillStart (detail: GestureDetail) => Promise<void> undefined A callback that fires when a gesture is about to start. This is fired after canStart but before onStart. onStart GestureCallback | undefined undefined A callback that fires when a gesture has started. onMove GestureCallback | undefined undefined A callback that fires when a gesture movement was detected. onEnd GestureCallback | undefined undefined A callback that fires when a gesture has ended. This is usually when a pointer has been released. notCaptured GestureCallback | undefined undefined A callback that fires when a gesture has not been captured. This usually happens when there is a conflicting gesture with a higher priority. GestureDetail Property Type Description type string The type of gesture that was detected. startX number The starting x coordinate of the gesture. startY number The starting y coordinate of the gesture. startTimeStamp number The timestamp at which the gesture was started. currentX number The current x coordinate of the gesture. currentY number The current y coordinate of the gesture. velocityX number How fast the gesture is currently moving on the x axis. velocityY number How fast the gesture is currently moving on the y axis. deltaX number How much the gesture has moved on the x axis since it started. deltaY number How much the gesture has moved on the y axis since it started. timeStamp number The current timestamp of the gesture. event UIEvent The native event dispatched by the browser. See UIEvent for more information. data any | undefined Any data specified by the user. This can be set and read in any of the callbacks. enable(enable: boolean = true) => void
Enable or disable the gesture.
destroy() => void
Destroy the gesture instance and stop listening on the target element.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4