ionic-angular
Version:
A powerful framework for building mobile and progressive web apps with JavaScript and Angular
110 lines • 2.7 kB
JavaScript
import { Injectable } from '@angular/core';
import { Platform } from '../platform/platform';
/**
* \@name Haptic
* \@description
* The `Haptic` class interacts with a haptic engine on the device, if
* available. Generally, Ionic components use this under the hood, but you're
* welcome to get a bit crazy with it if you fancy.
*
* Currently, this uses the Taptic engine on iOS.
*
* \@usage
* ```ts
* export class MyClass{
* constructor(haptic: Haptic){
* haptic.selection();
* }
* }
*
* ```
*/
export class Haptic {
/**
* @param {?} plt
*/
constructor(plt) {
if (plt) {
plt.ready().then(() => {
this._p = plt.win().TapticEngine;
});
}
}
/**
* Check to see if the Haptic Plugin is available
*
* @return {?}
*/
available() {
return !!this._p;
}
/**
* Trigger a selection changed haptic event. Good for one-time events
* (not for gestures)
* @return {?}
*/
selection() {
this._p && this._p.selection();
}
/**
* Tell the haptic engine that a gesture for a selection change is starting.
* @return {?}
*/
gestureSelectionStart() {
this._p && this._p.gestureSelectionStart();
}
/**
* Tell the haptic engine that a selection changed during a gesture.
* @return {?}
*/
gestureSelectionChanged() {
this._p && this._p.gestureSelectionChanged();
}
/**
* Tell the haptic engine we are done with a gesture. This needs to be
* called lest resources are not properly recycled.
* @return {?}
*/
gestureSelectionEnd() {
this._p && this._p.gestureSelectionEnd();
}
/**
* Use this to indicate success/failure/warning to the user.
* options should be of the type `{ type: 'success' }` (or `warning`/`error`)
* @param {?} options
* @return {?}
*/
notification(options) {
this._p && this._p.notification(options);
}
/**
* Use this to indicate success/failure/warning to the user.
* options should be of the type `{ style: 'light' }` (or `medium`/`heavy`)
* @param {?} options
* @return {?}
*/
impact(options) {
this._p && this._p.impact(options);
}
}
Haptic.decorators = [
{ type: Injectable },
];
/**
* @nocollapse
*/
Haptic.ctorParameters = () => [
{ type: Platform, },
];
function Haptic_tsickle_Closure_declarations() {
/** @type {?} */
Haptic.decorators;
/**
* @nocollapse
* @type {?}
*/
Haptic.ctorParameters;
/** @type {?} */
Haptic.prototype._p;
}
//# sourceMappingURL=haptic.js.map