awesome-cordova-plugins/src/@ionic-native/plugins/navigation-bar/index.ts
2019-03-19 18:34:54 +01:00

61 lines
1.3 KiB
TypeScript

import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/**
* @beta
* @name Navigation Bar
* @description
* The NavigationBar plugin allows you to hide and auto hide the android navigation bar.
*
* @usage
* ```typescript
* import { NavigationBar } from '@ionic-native/navigation-bar/ngx';
*
* constructor(private navigationBar: NavigationBar) { }
*
* ...
*
* let autoHide: boolean = true;
* this.navigationBar.setUp(autoHide);
* ```
*/
@Plugin({
pluginName: 'NavigationBar',
plugin: 'cordova-plugin-navigationbar',
pluginRef: 'navigationbar',
repo: 'https://github.com/cranberrygame/cordova-plugin-navigationbar',
platforms: ['Android']
})
@Injectable()
export class NavigationBar extends IonicNativePlugin {
/**
* hide automatically (or not) the navigation bar.
* @param autohide {boolean}
* @return {Promise<any>}
*/
@Cordova({
callbackStyle: 'object',
successName: 'success',
errorName: 'failure'
})
setUp(autohide?: boolean): Promise<any> {
return;
}
/**
* Hide the navigation bar.
* @return {Promise<any>}
*/
@Cordova({
callbackStyle: 'object',
successName: 'success',
errorName: 'failure'
})
hideNavigationBar(): Promise<any> {
return;
}
}