javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(): minor doc updates

Browse Source
This commit is contained in:
mhartington
2016-10-10 09:12:58 -04:00
parent c9b11811ed
commit da62b63253
6 changed files with 25 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/util/haptic.ts
View File

@@ -26,6 +26,10 @@ declare var window;
@Injectable()
export class Haptic {
/**
* @internal
*/
plugin: any;
constructor(platform: Platform) {
@@ -34,6 +38,11 @@ export class Haptic {
});
}
/**
* Check to see if the Haptic Plugin is available
* @return {boolean} Retuns true or false if the plugin is available
*
*/
available() {
return !!this.plugin;
}
@@ -85,7 +94,7 @@ export class Haptic {
/**
* Use this to indicate success/failure/warning to the user.
* options should be of the type { type: 'success' } (or 'warning'/'error')
* options should be of the type `{ type: 'success' }` (or `warning`/`error`)
*/
notification(options: { type: string }) {
if (!this.plugin) {
@@ -97,7 +106,7 @@ export class Haptic {
/**
* Use this to indicate success/failure/warning to the user.
* options should be of the type { style: 'light' } (or 'medium'/'heavy')
* options should be of the type `{ style: 'light' }` (or `medium`/`heavy`)
*/
impact(options: { style: string }) {
if (!this.plugin) {