github/cordova-plugin-statusbar
github/cordova-plugin-statusbar
3
0
Fork 0
mirror of https://github.com/apache/cordova-plugin-statusbar.git synced 2025-01-19 01:12:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: update typings (#132)

Browse Source 
This is part of [apache/cordova#39](https://github.com/apache/cordova/issues/39)
This commit is contained in:
Tim Brust 2019-05-07 11:24:12 +02:00 committed by Jan Piotrowski
parent a07612a299
commit 003fa61030
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
types/index.d.ts vendored
View File

@ -1,6 +1,7 @@
// Type definitions for Apache Cordova StatusBar plugin // Type definitions for cordova-plugin-statusbar 2.4
// Project: https://github.com/apache/cordova-plugin-statusbar // Project: https://github.com/apache/cordova-plugin-statusbar
// Definitions by: Xinkai Chen <https://github.com/Xinkai> // Definitions by: Xinkai Chen <https://github.com/Xinkai>
// Tim Brust <https://github.com/timbru31>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/** /**
@ -8,65 +9,68 @@
*/ */
interface Window { interface Window {
StatusBar: StatusBar; StatusBar: StatusBar;
addEventListener(type: "statusTap", listener: (ev: Event) => any, useCapture?: boolean): void;
} }
/** /**
* The StatusBar object provides some functions to customize the iOS and Android StatusBar. * The StatusBar object provides some functions to customize the iOS and Android StatusBar.
*/ */
interface StatusBar { interface StatusBar {
/** /**
* On iOS 7, make the statusbar overlay or not overlay the WebView. * On iOS 7, make the statusbar overlay or not overlay the WebView.
* @param isOverlay On iOS 7, set to false to make the statusbar appear like iOS 6. *
* Set the style and background color to suit using the other functions. * @param isOverlay - On iOS 7, set to false to make the statusbar appear like iOS 6.
* Set the style and background color to suit using the other functions.
*/ */
overlaysWebView: (isOverlay: boolean) => void; overlaysWebView(isOverlay: boolean): void;
/** /**
* Use the default statusbar (dark text, for light backgrounds). * Use the default statusbar (dark text, for light backgrounds).
*/ */
styleDefault: () => void; styleDefault(): void;
/** /**
* Use the lightContent statusbar (light text, for dark backgrounds). * Use the lightContent statusbar (light text, for dark backgrounds).
*/ */
styleLightContent: () => void; styleLightContent(): void;
/** /**
* Use the blackTranslucent statusbar (light text, for dark backgrounds). * Use the blackTranslucent statusbar (light text, for dark backgrounds).
*/ */
styleBlackTranslucent: () => void; styleBlackTranslucent(): void;
/** /**
* Use the blackOpaque statusbar (light text, for dark backgrounds). * Use the blackOpaque statusbar (light text, for dark backgrounds).
*/ */
styleBlackOpaque: () => void; styleBlackOpaque(): void;
/** /**
* On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, * On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false,
* you can set the background color of the statusbar by color name. * you can set the background color of the statusbar by color name.
* @param color Supported color names are: *
* black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown * @param color - Supported color names are:
* black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
*/ */
backgroundColorByName: (color: string) => void; backgroundColorByName(color: string): void;
/** /**
* Sets the background color of the statusbar by a hex string. * Sets the background color of the statusbar by a hex string.
* @param color CSS shorthand properties are also supported. *
* On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB). * @param color - CSS shorthand properties are also supported.
* On WP7 and WP8 you can also specify values as #AARRGGBB, where AA is an alpha value * On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB).
* On WP7 and WP8 you can also specify values as #AARRGGBB, where AA is an alpha value
*/ */
backgroundColorByHexString: (color: string) => void; backgroundColorByHexString(color: string): void;
/** /**
* Hide the statusbar. * Hide the statusbar.
*/ */
hide: () => void; hide(): void;
/** /**
* Show the statusbar. * Show the statusbar.
*/ */
show: () => void; show(): void;
/** /**
* Read this property to see if the statusbar is visible or not. * Read this property to see if the statusbar is visible or not.