capacitor-plugin-status-bar 2.0.1 → 2.0.2

package/README.md

@@ -137,7 +137,7 @@ getSafeAreaInsets() => Promise<SafeAreaInsets>
 
 Get the safe area insets.
 Returns the insets for status bar, navigation bar, and notch areas.
-Values are in pixels on Android and points on iOS.
+Values are in CSS pixels (dp) on all platforms.
 
 **Returns:** <code>Promise&lt;<a href="#safeareainsets">SafeAreaInsets</a>&gt;</code>
 

package/android/src/main/java/com/cap/plugins/statusbar/StatusBar.java

@@ -21,7 +21,6 @@ import androidx.core.view.WindowInsetsCompat;
 
 import com.getcapacitor.Plugin;
 
-import java.util.Objects;
 
 /**
  * Android Status Bar utilities with Android 10-15+ (API 29-35+) support.
@@ -279,60 +278,45 @@ public class StatusBar extends Plugin {
      * Returns the insets for status bar, navigation bar, and notch areas.
      *
      * @param activity The activity to get the insets from
-     * @return A map containing top, bottom, left, and right inset values in pixels
+     * @return A map containing top, bottom, left, and right inset values in dp (density-independent pixels)
      */
     public java.util.Map<String, Integer> getSafeAreaInsets(Activity activity) {
         Log.d(TAG, "getSafeAreaInsets");
         java.util.Map<String, Integer> insets = new java.util.HashMap<>();
+        float density = activity.getResources().getDisplayMetrics().density;
 
-        Window window = activity.getWindow();
-        View decorView = window.getDecorView();
-
-        WindowInsets windowInsets = decorView.getRootWindowInsets();
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
-            // API 30+ (Android 11+) - Use WindowInsets API
-            if (windowInsets != null) {
-                android.graphics.Insets systemBarsInsets = windowInsets.getInsets(WindowInsets.Type.systemBars());
-                android.graphics.Insets displayCutoutInsets = windowInsets.getInsets(WindowInsets.Type.displayCutout());
-
-                // Combine system bars and display cutout insets (use maximum of both)
-                insets.put("top", Math.max(systemBarsInsets.top, displayCutoutInsets.top));
-                insets.put("bottom", Math.max(systemBarsInsets.bottom, displayCutoutInsets.bottom));
-                insets.put("left", Math.max(systemBarsInsets.left, displayCutoutInsets.left));
-                insets.put("right", Math.max(systemBarsInsets.right, displayCutoutInsets.right));
-
-                Log.d(TAG, "getSafeAreaInsets (API 30+): top=" + insets.get("top")
-                        + ", bottom=" + insets.get("bottom")
-                        + ", left=" + insets.get("left")
-                        + ", right=" + insets.get("right"));
-            } else {
-                // Fallback to zero insets
-                insets.put("top", 0);
-                insets.put("bottom", 0);
-                insets.put("left", 0);
-                insets.put("right", 0);
-                Log.w(TAG, "getSafeAreaInsets: windowInsets is null");
-            }
+        View decorView = activity.getWindow().getDecorView();
+        WindowInsetsCompat windowInsets = ViewCompat.getRootWindowInsets(decorView);
+
+        if (windowInsets != null) {
+            // Use WindowInsetsCompat for accurate, type-specific insets across all API levels
+            androidx.core.graphics.Insets statusBars = windowInsets.getInsets(WindowInsetsCompat.Type.statusBars());
+            androidx.core.graphics.Insets navBars = windowInsets.getInsets(WindowInsetsCompat.Type.navigationBars());
+            androidx.core.graphics.Insets displayCutout = windowInsets.getInsets(WindowInsetsCompat.Type.displayCutout());
+
+            int topPx = Math.max(statusBars.top, displayCutout.top);
+            int bottomPx = Math.max(navBars.bottom, displayCutout.bottom);
+            int leftPx = Math.max(navBars.left, displayCutout.left);
+            int rightPx = Math.max(navBars.right, displayCutout.right);
+
+            // Convert physical pixels to dp (CSS pixels) for the WebView layer
+            insets.put("top", Math.round(topPx / density));
+            insets.put("bottom", Math.round(bottomPx / density));
+            insets.put("left", Math.round(leftPx / density));
+            insets.put("right", Math.round(rightPx / density));
+
+            Log.d(TAG, "getSafeAreaInsets: topPx=" + topPx + " bottomPx=" + bottomPx
+                    + " density=" + density
+                    + " -> top=" + insets.get("top") + "dp"
+                    + " bottom=" + insets.get("bottom") + "dp"
+                    + " left=" + insets.get("left") + "dp"
+                    + " right=" + insets.get("right") + "dp");
         } else {
-            // API 29 (Android 10) - Use deprecated system window insets
-            if (windowInsets != null) {
-                insets.put("top", windowInsets.getSystemWindowInsetTop());
-                insets.put("bottom", windowInsets.getSystemWindowInsetBottom());
-                insets.put("left", windowInsets.getSystemWindowInsetLeft());
-                insets.put("right", windowInsets.getSystemWindowInsetRight());
-
-                Log.d(TAG, "getSafeAreaInsets (API 29): top=" + insets.get("top")
-                        + ", bottom=" + insets.get("bottom")
-                        + ", left=" + insets.get("left")
-                        + ", right=" + insets.get("right"));
-            } else {
-                // Fallback to zero insets
-                insets.put("top", 0);
-                insets.put("bottom", 0);
-                insets.put("left", 0);
-                insets.put("right", 0);
-                Log.w(TAG, "getSafeAreaInsets: windowInsets is null");
-            }
+            insets.put("top", 0);
+            insets.put("bottom", 0);
+            insets.put("left", 0);
+            insets.put("right", 0);
+            Log.w(TAG, "getSafeAreaInsets: windowInsets is null");
         }
 
         return insets;
@@ -432,26 +416,37 @@ public class StatusBar extends Plugin {
             // Add to the top of the decor view
             decorView.addView(overlay);
 
-            // Apply correct height from insets
-            ViewCompat.setOnApplyWindowInsetsListener(overlay, (v, windowInsets) -> {
-                int top;
-                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
-                    top = Objects.requireNonNull(windowInsets.toWindowInsets())
-                            .getInsets(WindowInsets.Type.statusBars()).top;
-                } else {
-                    top = Objects.requireNonNull(windowInsets.toWindowInsets()).getSystemWindowInsetTop();
+            // Listen on decorView for reliable insets dispatch across all API levels,
+            // then use WindowInsetsCompat.Type.statusBars() for accurate status-bar-only height
+            ViewCompat.setOnApplyWindowInsetsListener(decorView, (v, windowInsets) -> {
+                int top = windowInsets.getInsets(WindowInsetsCompat.Type.statusBars()).top;
+                View statusOverlay = decorView.findViewWithTag(STATUS_BAR_OVERLAY_TAG);
+                if (statusOverlay != null) {
+                    ViewGroup.LayoutParams params = statusOverlay.getLayoutParams();
+                    if (params.height != top) {
+                        params.height = top;
+                        statusOverlay.setLayoutParams(params);
+                    }
+                }
+
+                int bottom = windowInsets.getInsets(WindowInsetsCompat.Type.navigationBars()).bottom;
+                View navOverlay = decorView.findViewWithTag(NAV_BAR_OVERLAY_TAG);
+                if (navOverlay != null) {
+                    ViewGroup.LayoutParams params = navOverlay.getLayoutParams();
+                    if (params.height != bottom) {
+                        params.height = bottom;
+                        navOverlay.setLayoutParams(params);
+                    }
                 }
-                ViewGroup.LayoutParams params = v.getLayoutParams();
-                params.height = top;
-                v.setLayoutParams(params);
-                // Don't set color here - it's set before listener and should not be overridden
+
+                ViewCompat.onApplyWindowInsets(v, windowInsets);
                 return windowInsets;
             });
-            overlay.requestApplyInsets();
+            decorView.requestApplyInsets();
         } else {
             Log.d(TAG, "ensureStatusBarOverlay: updating existing overlay");
             existing.setBackgroundColor(color);
-            existing.requestApplyInsets();
+            decorView.requestApplyInsets();
         }
     }
 
@@ -483,25 +478,39 @@ public class StatusBar extends Plugin {
 
             decorView.addView(overlay);
 
-            ViewCompat.setOnApplyWindowInsetsListener(overlay, (v, windowInsets) -> {
-                int bottom;
-                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
-                    bottom = Objects.requireNonNull(windowInsets.toWindowInsets())
-                            .getInsets(WindowInsets.Type.navigationBars()).bottom;
-                } else {
-                    bottom = Objects.requireNonNull(windowInsets.toWindowInsets()).getSystemWindowInsetBottom();
-                }
-                ViewGroup.LayoutParams params = v.getLayoutParams();
-                params.height = bottom;
-                v.setLayoutParams(params);
-                // Don't set color here - it's set before listener and should not be overridden
-                return windowInsets;
-            });
-            overlay.requestApplyInsets();
+            // Insets sizing is handled by the shared decorView listener in ensureStatusBarOverlay.
+            // If status bar overlay was not created yet, set up the listener here.
+            if (decorView.findViewWithTag(STATUS_BAR_OVERLAY_TAG) == null) {
+                ViewCompat.setOnApplyWindowInsetsListener(decorView, (v, windowInsets) -> {
+                    int top = windowInsets.getInsets(WindowInsetsCompat.Type.statusBars()).top;
+                    View statusOverlay = decorView.findViewWithTag(STATUS_BAR_OVERLAY_TAG);
+                    if (statusOverlay != null) {
+                        ViewGroup.LayoutParams params = statusOverlay.getLayoutParams();
+                        if (params.height != top) {
+                            params.height = top;
+                            statusOverlay.setLayoutParams(params);
+                        }
+                    }
+
+                    int bottom = windowInsets.getInsets(WindowInsetsCompat.Type.navigationBars()).bottom;
+                    View navOverlay = decorView.findViewWithTag(NAV_BAR_OVERLAY_TAG);
+                    if (navOverlay != null) {
+                        ViewGroup.LayoutParams params = navOverlay.getLayoutParams();
+                        if (params.height != bottom) {
+                            params.height = bottom;
+                            navOverlay.setLayoutParams(params);
+                        }
+                    }
+
+                    ViewCompat.onApplyWindowInsets(v, windowInsets);
+                    return windowInsets;
+                });
+            }
+            decorView.requestApplyInsets();
         } else {
             Log.d(TAG, "ensureNavBarOverlay: updating existing overlay");
             existing.setBackgroundColor(color);
-            existing.requestApplyInsets();
+            decorView.requestApplyInsets();
         }
     }
 

package/dist/docs.json

@@ -150,7 +150,7 @@
         "parameters": [],
         "returns": "Promise<SafeAreaInsets>",
         "tags": [],
-        "docs": "Get the safe area insets.\nReturns the insets for status bar, navigation bar, and notch areas.\nValues are in pixels on Android and points on iOS.",
+        "docs": "Get the safe area insets.\nReturns the insets for status bar, navigation bar, and notch areas.\nValues are in CSS pixels (dp) on all platforms.",
         "complexTypes": [
           "SafeAreaInsets"
         ],

package/dist/esm/definitions.d.ts

@@ -90,7 +90,7 @@ export interface StatusBarPlugin {
     /**
      * Get the safe area insets.
      * Returns the insets for status bar, navigation bar, and notch areas.
-     * Values are in pixels on Android and points on iOS.
+     * Values are in CSS pixels (dp) on all platforms.
      */
     getSafeAreaInsets(): Promise<SafeAreaInsets>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,wBAAe,CAAA;IACf,sBAAa,CAAA;IACb,0BAAiB,CAAA;AACnB,CAAC,EAJW,KAAK,KAAL,KAAK,QAIhB;AAWD,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,qCAAe,CAAA;AACjB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B","sourcesContent":["export enum Style {\n  LIGHT = 'LIGHT',\n  DARK = 'DARK',\n  CUSTOM = 'CUSTOM',\n}\n\n/**\n * Full HEX color format only (6 or 8 digits).\n * - 6 digits: #RRGGBB (e.g., #FFFFFF, #000000, #FF5733)\n * - 8 digits: #RRGGBBAA with alpha channel (e.g., #FFFFFF00, #FF5733CC)\n *\n * Note: Short 3-digit format (#FFF) is NOT supported.\n */\nexport type StatusBarColor = `#${string}`;\n\nexport enum StatusBarAnimation {\n  NONE = 'none',\n  FADE = 'fade',\n  SLIDE = 'slide',\n}\n\ntype StatusBarStyleNoDefaultOptions = {\n  style: Style;\n};\n\ntype StatusBarStyleOptions =\n  | StatusBarStyleNoDefaultOptions\n  | {\n      style: Style.CUSTOM;\n      color: StatusBarColor;\n    };\n\nexport type StatusBarOptions = StatusBarStyleOptions;\n\nexport type StatusBarShowOptions = {\n  animated: boolean;\n};\n\nexport type StatusBarHideOptions = {\n  /**\n   * The animation type for hiding the status bar.\n   * - 'fade': Makes the background transparent without removing the status bar and navigation bar.\n   * - 'slide': Hides the status bar and navigation bar completely (default behavior).\n   */\n  animation: StatusBarAnimation;\n};\n\nexport type StatusBarSetOverlaysWebViewOptions = {\n  value: boolean;\n};\n\nexport type StatusBarSetBackgroundOptions = {\n  color: StatusBarColor;\n};\n\nexport type SafeAreaInsets = {\n  top: number;\n  bottom: number;\n  left: number;\n  right: number;\n};\n\nexport interface StatusBarPlugin {\n  /**\n   * Set the status bar and navigation bar style and color.\n   * @param options - The options to set the status bar style and color.\n   * @param options.style - The style of the status bar.\n   * @param options.color - The color of the status bar.\n   */\n  setStyle(options: StatusBarOptions): Promise<void>;\n  /**\n   * Show the status bar.\n   * @param options - The options to show the status bar.\n   * @param options.animated - Whether to animate the status bar.\n   */\n  show(options: StatusBarShowOptions): Promise<void>;\n  /**\n   * Hide the status bar.\n   * @param options - The options to hide the status bar.\n   * @param options.animation - The animation type: 'fade' makes background transparent, 'slide' hides bars completely.\n   */\n  hide(options: StatusBarHideOptions): Promise<void>;\n  /**\n   * Set whether the status bar overlays the web view.\n   *\n   * **iOS only** - On Android this is a no-op (resolves without error).\n   *\n   * - `true`: Web content extends behind the status bar (transparent background),\n   *   allowing content to be visible through the status bar area on scroll.\n   * - `false`: Restores the status bar background to the color set by `setStyle`\n   *   or falls back to the default style from Capacitor config.\n   *\n   * @param options - The options to set the status bar overlays web view.\n   * @param options.value - Whether the status bar overlays the web view (required).\n   */\n  setOverlaysWebView(options: StatusBarSetOverlaysWebViewOptions): Promise<void>;\n  /**\n   * Set the window background color.\n   * @param options - The options to set the window background color.\n   * @param options.color - The background color in HEX format.\n   */\n  setBackground(options: StatusBarSetBackgroundOptions): Promise<void>;\n  /**\n   * Get the safe area insets.\n   * Returns the insets for status bar, navigation bar, and notch areas.\n   * Values are in pixels on Android and points on iOS.\n   */\n  getSafeAreaInsets(): Promise<SafeAreaInsets>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,wBAAe,CAAA;IACf,sBAAa,CAAA;IACb,0BAAiB,CAAA;AACnB,CAAC,EAJW,KAAK,KAAL,KAAK,QAIhB;AAWD,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,qCAAe,CAAA;AACjB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B","sourcesContent":["export enum Style {\n  LIGHT = 'LIGHT',\n  DARK = 'DARK',\n  CUSTOM = 'CUSTOM',\n}\n\n/**\n * Full HEX color format only (6 or 8 digits).\n * - 6 digits: #RRGGBB (e.g., #FFFFFF, #000000, #FF5733)\n * - 8 digits: #RRGGBBAA with alpha channel (e.g., #FFFFFF00, #FF5733CC)\n *\n * Note: Short 3-digit format (#FFF) is NOT supported.\n */\nexport type StatusBarColor = `#${string}`;\n\nexport enum StatusBarAnimation {\n  NONE = 'none',\n  FADE = 'fade',\n  SLIDE = 'slide',\n}\n\ntype StatusBarStyleNoDefaultOptions = {\n  style: Style;\n};\n\ntype StatusBarStyleOptions =\n  | StatusBarStyleNoDefaultOptions\n  | {\n      style: Style.CUSTOM;\n      color: StatusBarColor;\n    };\n\nexport type StatusBarOptions = StatusBarStyleOptions;\n\nexport type StatusBarShowOptions = {\n  animated: boolean;\n};\n\nexport type StatusBarHideOptions = {\n  /**\n   * The animation type for hiding the status bar.\n   * - 'fade': Makes the background transparent without removing the status bar and navigation bar.\n   * - 'slide': Hides the status bar and navigation bar completely (default behavior).\n   */\n  animation: StatusBarAnimation;\n};\n\nexport type StatusBarSetOverlaysWebViewOptions = {\n  value: boolean;\n};\n\nexport type StatusBarSetBackgroundOptions = {\n  color: StatusBarColor;\n};\n\nexport type SafeAreaInsets = {\n  top: number;\n  bottom: number;\n  left: number;\n  right: number;\n};\n\nexport interface StatusBarPlugin {\n  /**\n   * Set the status bar and navigation bar style and color.\n   * @param options - The options to set the status bar style and color.\n   * @param options.style - The style of the status bar.\n   * @param options.color - The color of the status bar.\n   */\n  setStyle(options: StatusBarOptions): Promise<void>;\n  /**\n   * Show the status bar.\n   * @param options - The options to show the status bar.\n   * @param options.animated - Whether to animate the status bar.\n   */\n  show(options: StatusBarShowOptions): Promise<void>;\n  /**\n   * Hide the status bar.\n   * @param options - The options to hide the status bar.\n   * @param options.animation - The animation type: 'fade' makes background transparent, 'slide' hides bars completely.\n   */\n  hide(options: StatusBarHideOptions): Promise<void>;\n  /**\n   * Set whether the status bar overlays the web view.\n   *\n   * **iOS only** - On Android this is a no-op (resolves without error).\n   *\n   * - `true`: Web content extends behind the status bar (transparent background),\n   *   allowing content to be visible through the status bar area on scroll.\n   * - `false`: Restores the status bar background to the color set by `setStyle`\n   *   or falls back to the default style from Capacitor config.\n   *\n   * @param options - The options to set the status bar overlays web view.\n   * @param options.value - Whether the status bar overlays the web view (required).\n   */\n  setOverlaysWebView(options: StatusBarSetOverlaysWebViewOptions): Promise<void>;\n  /**\n   * Set the window background color.\n   * @param options - The options to set the window background color.\n   * @param options.color - The background color in HEX format.\n   */\n  setBackground(options: StatusBarSetBackgroundOptions): Promise<void>;\n  /**\n   * Get the safe area insets.\n   * Returns the insets for status bar, navigation bar, and notch areas.\n   * Values are in CSS pixels (dp) on all platforms.\n   */\n  getSafeAreaInsets(): Promise<SafeAreaInsets>;\n}\n"]}

package/ios/Sources/StatusBarPlugin/StatusBar.swift

@@ -230,13 +230,19 @@ import Capacitor
 
             if let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene,
                let window = windowScene.windows.first {
+                // Use statusBarManager for accurate status bar height
+                let statusBarHeight = windowScene.statusBarManager?.statusBarFrame.height ?? 0
                 let safeAreaInsets = window.safeAreaInsets
-                insets["top"] = safeAreaInsets.top
+
+                // top: status bar height specifically
+                insets["top"] = statusBarHeight
+                // bottom: home indicator / navigation bar area
                 insets["bottom"] = safeAreaInsets.bottom
+                // left/right: safe area for landscape / display cutouts
                 insets["left"] = safeAreaInsets.left
                 insets["right"] = safeAreaInsets.right
 
-                print("StatusBar: getSafeAreaInsets - top=\(safeAreaInsets.top), bottom=\(safeAreaInsets.bottom), left=\(safeAreaInsets.left), right=\(safeAreaInsets.right)")
+                print("StatusBar: getSafeAreaInsets - top=\(statusBarHeight), bottom=\(safeAreaInsets.bottom), left=\(safeAreaInsets.left), right=\(safeAreaInsets.right)")
             } else {
                 print("StatusBar: getSafeAreaInsets - Unable to get window, returning zero insets")
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-plugin-status-bar",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Capacitor plugin for managing the status bar style, visibility, and color on iOS and Android. Control overlay modes, background colors, and appearance for native mobile applications.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",