fix(status-bar): add missing types (#2498) (#2500)

Author: jcesarmobile

status-bar/README.md

@@ -111,7 +111,10 @@ export default config;
 * [`hide(...)`](#hide)
 * [`getInfo()`](#getinfo)
 * [`setOverlaysWebView(...)`](#setoverlayswebview)
+* [`addListener('statusBarVisibilityChanged', ...)`](#addlistenerstatusbarvisibilitychanged-)
+* [`addListener('statusBarOverlayChanged', ...)`](#addlistenerstatusbaroverlaychanged-)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 * [Enums](#enums)
 
 </docgen-index>
@@ -224,6 +227,48 @@ of the space underneath it.
 --------------------
 
 
+### addListener('statusBarVisibilityChanged', ...)
+
+```typescript
+addListener(eventName: 'statusBarVisibilityChanged', listenerFunc: VisibilityChangeListener) => Promise<PluginListenerHandle>
+```
+
+Listen for status bar visibility changes.
+Fired when hide or show methods get called.
+
+| Param              | Type                                                                          |
+| ------------------ | ----------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'statusBarVisibilityChanged'</code>                                     |
+| **`listenerFunc`** | <code><a href="#visibilitychangelistener">VisibilityChangeListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 7.0.0
+
+--------------------
+
+
+### addListener('statusBarOverlayChanged', ...)
+
+```typescript
+addListener(eventName: 'statusBarOverlayChanged', listenerFunc: OverlayChangeListener) => Promise<PluginListenerHandle>
+```
+
+Listen for status bar overlay changes.
+Fired when setOverlaysWebView gets called.
+
+| Param              | Type                                                                    |
+| ------------------ | ----------------------------------------------------------------------- |
+| **`eventName`**    | <code>'statusBarOverlayChanged'</code>                                  |
+| **`listenerFunc`** | <code><a href="#overlaychangelistener">OverlayChangeListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 7.0.0
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -250,12 +295,13 @@ of the space underneath it.
 
 #### StatusBarInfo
 
-| Prop           | Type                                    | Description                               | Since |
-| -------------- | --------------------------------------- | ----------------------------------------- | ----- |
-| **`visible`**  | <code>boolean</code>                    | Whether the status bar is visible or not. | 1.0.0 |
-| **`style`**    | <code><a href="#style">Style</a></code> | The current status bar style.             | 1.0.0 |
-| **`color`**    | <code>string</code>                     | The current status bar color.             | 1.0.0 |
-| **`overlays`** | <code>boolean</code>                    | Whether the statusbar is overlaid or not. | 1.0.0 |
+| Prop           | Type                                    | Description                                | Since |
+| -------------- | --------------------------------------- | ------------------------------------------ | ----- |
+| **`visible`**  | <code>boolean</code>                    | Whether the status bar is visible or not.  | 1.0.0 |
+| **`style`**    | <code><a href="#style">Style</a></code> | The current status bar style.              | 1.0.0 |
+| **`color`**    | <code>string</code>                     | The current status bar color.              | 1.0.0 |
+| **`overlays`** | <code>boolean</code>                    | Whether the status bar is overlaid or not. | 1.0.0 |
+| **`height`**   | <code>number</code>                     | The height of the status bar.              | 7.0.0 |
 
 
 #### SetOverlaysWebViewOptions
@@ -265,6 +311,26 @@ of the space underneath it.
 | **`overlay`** | <code>boolean</code> | Whether to overlay the status bar or not. | 1.0.0 |
 
 
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+### Type Aliases
+
+
+#### VisibilityChangeListener
+
+<code>(info: <a href="#statusbarinfo">StatusBarInfo</a>): void</code>
+
+
+#### OverlayChangeListener
+
+<code>(info: <a href="#statusbarinfo">StatusBarInfo</a>): void</code>
+
+
 ### Enums
 
 

status-bar/src/definitions.ts

@@ -1,5 +1,7 @@
 /// <reference types="@capacitor/cli" />
 
+import type { PluginListenerHandle } from '@capacitor/core';
+
 declare module '@capacitor/cli' {
   export interface PluginsConfig {
     /**
@@ -143,14 +145,21 @@ export interface StatusBarInfo {
    *
    * @since 1.0.0
    */
-  color?: string;
+  color: string;
 
   /**
-   * Whether the statusbar is overlaid or not.
+   * Whether the status bar is overlaid or not.
    *
    * @since 1.0.0
    */
-  overlays?: boolean;
+  overlays: boolean;
+
+  /**
+   * The height of the status bar.
+   *
+   * @since 7.0.0
+   */
+  height: number;
 }
 
 export interface SetOverlaysWebViewOptions {
@@ -162,6 +171,9 @@ export interface SetOverlaysWebViewOptions {
   overlay: boolean;
 }
 
+export type VisibilityChangeListener = (info: StatusBarInfo) => void;
+export type OverlayChangeListener = (info: StatusBarInfo) => void;
+
 export interface StatusBarPlugin {
   /**
    * Set the current style of the status bar.
@@ -209,6 +221,28 @@ export interface StatusBarPlugin {
    * @since 1.0.0
    */
   setOverlaysWebView(options: SetOverlaysWebViewOptions): Promise<void>;
+
+  /**
+   * Listen for status bar visibility changes.
+   * Fired when hide or show methods get called.
+   *
+   * @since 7.0.0
+   */
+  addListener(
+    eventName: 'statusBarVisibilityChanged',
+    listenerFunc: VisibilityChangeListener,
+  ): Promise<PluginListenerHandle>;
+
+  /**
+   * Listen for status bar overlay changes.
+   * Fired when setOverlaysWebView gets called.
+   *
+   * @since 7.0.0
+   */
+  addListener(
+    eventName: 'statusBarOverlayChanged',
+    listenerFunc: OverlayChangeListener,
+  ): Promise<PluginListenerHandle>;
 }
 
 /**