Skip to content

Commit

Permalink
feat: update typings (#132)
Browse files Browse the repository at this point in the history
  • Loading branch information
timbru31 authored and janpio committed May 7, 2019
1 parent a07612a commit 003fa61
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,72 +1,76 @@
// Type definitions for Apache Cordova StatusBar plugin
// Type definitions for cordova-plugin-statusbar 2.4
// Project: https://github.com/apache/cordova-plugin-statusbar
// Definitions by: Xinkai Chen <https://github.com/Xinkai>
// Tim Brust <https://github.com/timbru31>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
* Global object StatusBar.
*/
interface Window {
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.
*/
interface StatusBar {
/**
* 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).
*/
styleDefault: () => void;
styleDefault(): void;

/**
* Use the lightContent statusbar (light text, for dark backgrounds).
*/
styleLightContent: () => void;
styleLightContent(): void;

/**
* Use the blackTranslucent statusbar (light text, for dark backgrounds).
*/
styleBlackTranslucent: () => void;
styleBlackTranslucent(): void;

/**
* Use the blackOpaque statusbar (light text, for dark backgrounds).
*/
styleBlackOpaque: () => void;
styleBlackOpaque(): void;

/**
* On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false,
* 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.
* @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).
* On WP7 and WP8 you can also specify values as #AARRGGBB, where AA is an alpha value
*
* @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).
* 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: () => void;
hide(): void;

/**
* Show the statusbar.
*/
show: () => void;
show(): void;

/**
* Read this property to see if the statusbar is visible or not.
Expand Down

0 comments on commit 003fa61

Please sign in to comment.