chore(statusbar): update StatusBar

dist/plugins/statusbar.d.ts

@@ -1,57 +1,59 @@
 /**
  * Manage the appearance of the native status bar.
  *
- * @usage
- * ```js
- * StatusBar.hide(); // Hide the bar
- *
- * StatusBar.setStyle(StatusBar.LIGHT_CONTENT) // Good for dark backgrounds
- * ```
+ * Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar).
  */
 export declare class StatusBar {
     /**
      * Set whether the status bar overlays the main app view. The default
      * is true.
      *
-     * @param doesOverlay whether the status bar overlays the main app view.
+     * @param {boolean} doesOverlay  Whether the status bar overlays the main app view.
+     */
+    static overlaysWebView(doesOverlay: boolean): void;
+    /**
+     * Use the default statusbar (dark text, for light backgrounds).
      */
-    static overlaysWebView(doOverlay: boolean): void;
     static styleDefault(): void;
+    /**
+     * Use the lightContent statusbar (light text, for dark backgrounds).
+     */
     static styleLightContent(): void;
+    /**
+     * Use the blackTranslucent statusbar (light text, for dark backgrounds).
+     */
     static styleBlackTranslucent(): void;
+    /**
+     * Use the blackOpaque statusbar (light text, for dark backgrounds).
+     */
     static styleBlackOpaque(): void;
     /**
      * Set the status bar to a specific named color. Valid options:
      * black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown.
      *
      * iOS note: you must call StatusBar.setOverlay(false) to enable color changing.
      *
-     * @param name the name of the color (from above)
+     * @param {string} colorName  The name of the color (from above)
      */
     static backgroundColorByName(colorName: string): void;
     /**
      * Set the status bar to a specific hex color (CSS shorthand supported!).
      *
      * iOS note: you must call StatusBar.setOverlay(false) to enable color changing.
      *
-     * @param hex the hex value of the color.
+     * @param {string} hexString  The hex value of the color.
      */
     static backgroundColorByHexString(hexString: string): void;
     /**
      * Hide the StatusBar
-     *
-     * Options:
-     *
-     * StatusBar.DEFAULT
-     * StatusBar.LIGHT_CONTENT
-     * StatusBar.BLACK_TRANSLUCENT
-     * StatusBar.BLACK_OPAQUE
-     *
-     * @param style the style from above
      */
     static hide(): void;
     /**
     * Show the StatusBar
     */
     static show(): void;
+    /**
+     * Whether the StatusBar is currently visible or not.
+     */
+    static isVisible(): any;
 }

src/plugins/statusbar.ts

@@ -1,15 +1,11 @@
-import {Plugin, Cordova} from './plugin';
+import {Plugin, Cordova, RequiresPlugin} from './plugin';
 
+declare var window;
 
 /**
  * Manage the appearance of the native status bar.
  *
- * @usage
- * ```js
- * StatusBar.hide(); // Hide the bar
- *
- * StatusBar.setStyle(StatusBar.LIGHT_CONTENT) // Good for dark backgrounds
- * ```
+ * Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar).
  */
 @Plugin({
   name: 'StatusBar',
@@ -21,21 +17,43 @@ export class StatusBar {
    * Set whether the status bar overlays the main app view. The default
    * is true.
    *
-   * @param doesOverlay whether the status bar overlays the main app view.
+   * @param {boolean} doesOverlay  Whether the status bar overlays the main app view.
    */
-  @Cordova()
-  static overlaysWebView(doOverlay:boolean){};
+  @Cordova({
+    sync: true
+  })
+  static overlaysWebView(doesOverlay: boolean){};
 
-  @Cordova()
+  /**
+   * Use the default statusbar (dark text, for light backgrounds).
+   */
+  @Cordova({
+    sync: true
+  })
   static styleDefault(){};
 
-  @Cordova()
+  /**
+   * Use the lightContent statusbar (light text, for dark backgrounds).
+   */
+  @Cordova({
+    sync: true
+  })
   static styleLightContent(){};
 
-  @Cordova()
+  /**
+   * Use the blackTranslucent statusbar (light text, for dark backgrounds).
+   */
+  @Cordova({
+    sync: true
+  })
   static styleBlackTranslucent(){};
-
-  @Cordova()
+
+  /**
+   * Use the blackOpaque statusbar (light text, for dark backgrounds).
+   */
+  @Cordova({
+    sync: true
+  })
   static styleBlackOpaque(){};
 
   /**
@@ -44,39 +62,46 @@ export class StatusBar {
    *
    * iOS note: you must call StatusBar.setOverlay(false) to enable color changing.
    *
-   * @param name the name of the color (from above)
+   * @param {string} colorName  The name of the color (from above)
    */
-  @Cordova()
-  static backgroundColorByName(colorName:string){};
+  @Cordova({
+    sync: true
+  })
+  static backgroundColorByName(colorName: string){};
 
   /**
    * Set the status bar to a specific hex color (CSS shorthand supported!).
    *
    * iOS note: you must call StatusBar.setOverlay(false) to enable color changing.
    *
-   * @param hex the hex value of the color.
+   * @param {string} hexString  The hex value of the color.
    */
-  @Cordova()
-  static backgroundColorByHexString(hexString:string){};
+  @Cordova({
+    sync: true
+  })
+  static backgroundColorByHexString(hexString: string){};
 
   /**
    * Hide the StatusBar
-   *
-   * Options:
-   *
-   * StatusBar.DEFAULT
-   * StatusBar.LIGHT_CONTENT
-   * StatusBar.BLACK_TRANSLUCENT
-   * StatusBar.BLACK_OPAQUE
-   *
-   * @param style the style from above
    */
-  @Cordova()
+  @Cordova({
+    sync: true
+  })
   static hide(){};
 
   /**
   * Show the StatusBar
   */
-  @Cordova()
+  @Cordova({
+    sync: true
+  })
   static show(){};
+
+  /**
+   * Whether the StatusBar is currently visible or not.
+   */
+  @RequiresPlugin
+  static isVisible() {
+    return window.StatusBar.isVisible;
+  }
 }