feat(android): add adjustMarginsForEdgeToEdge configuration option (#7885)

Co-authored-by: jcesarmobile <[email protected]>

Author: markemer

android/capacitor/src/main/java/com/getcapacitor/Bridge.java

@@ -1605,9 +1605,9 @@ public Bridge create() {
                 config
             );
 
-            if (webView instanceof CapacitorWebView) {
-                CapacitorWebView capacitorWebView = (CapacitorWebView) webView;
+            if (webView instanceof CapacitorWebView capacitorWebView) {
                 capacitorWebView.setBridge(bridge);
+                capacitorWebView.edgeToEdgeHandler(bridge);
             }
 
             bridge.setCordovaWebView(mockWebView);

android/capacitor/src/main/java/com/getcapacitor/CapConfig.java

@@ -54,6 +54,7 @@ public class CapConfig {
     private String errorPath;
     private boolean zoomableWebView = false;
     private boolean resolveServiceWorkerRequests = true;
+    private String adjustMarginsForEdgeToEdge = "disable";
 
     // Embedded
     private String startPath;
@@ -181,6 +182,7 @@ private CapConfig(Builder builder) {
         this.errorPath = builder.errorPath;
         this.zoomableWebView = builder.zoomableWebView;
         this.resolveServiceWorkerRequests = builder.resolveServiceWorkerRequests;
+        this.adjustMarginsForEdgeToEdge = builder.adjustMarginsForEdgeToEdge;
 
         // Embedded
         this.startPath = builder.startPath;
@@ -285,6 +287,7 @@ private void deserializeConfig(@Nullable Context context) {
         webContentsDebuggingEnabled = JSONUtils.getBoolean(configJSON, "android.webContentsDebuggingEnabled", isDebug);
         zoomableWebView = JSONUtils.getBoolean(configJSON, "android.zoomEnabled", JSONUtils.getBoolean(configJSON, "zoomEnabled", false));
         resolveServiceWorkerRequests = JSONUtils.getBoolean(configJSON, "android.resolveServiceWorkerRequests", true);
+        adjustMarginsForEdgeToEdge = JSONUtils.getString(configJSON, "android.adjustMarginsForEdgeToEdge", "disable");
 
         String logBehavior = JSONUtils.getString(
             configJSON,
@@ -401,6 +404,10 @@ public boolean isUsingLegacyBridge() {
         return useLegacyBridge;
     }
 
+    public String adjustMarginsForEdgeToEdge() {
+        return adjustMarginsForEdgeToEdge;
+    }
+
     public int getMinWebViewVersion() {
         if (minWebViewVersion < MINIMUM_ANDROID_WEBVIEW_VERSION) {
             Logger.warn("Specified minimum webview version is too low, defaulting to " + MINIMUM_ANDROID_WEBVIEW_VERSION);
@@ -581,6 +588,7 @@ public static class Builder {
         private int minHuaweiWebViewVersion = DEFAULT_HUAWEI_WEBVIEW_VERSION;
         private boolean zoomableWebView = false;
         private boolean resolveServiceWorkerRequests = true;
+        private String adjustMarginsForEdgeToEdge = "disable";
 
         // Embedded
         private String startPath = null;

android/capacitor/src/main/java/com/getcapacitor/CapacitorWebView.java

@@ -1,7 +1,9 @@
 package com.getcapacitor;
 
 import android.content.Context;
+import android.os.Build;
 import android.util.AttributeSet;
+import android.util.TypedValue;
 import android.view.KeyEvent;
 import android.view.inputmethod.BaseInputConnection;
 import android.view.inputmethod.EditorInfo;
@@ -18,7 +20,6 @@ public class CapacitorWebView extends WebView {
 
     public CapacitorWebView(Context context, AttributeSet attrs) {
         super(context, attrs);
-        edgeToEdgeHandler();
     }
 
     public void setBridge(Bridge bridge) {
@@ -54,19 +55,35 @@ public boolean dispatchKeyEvent(KeyEvent event) {
         return super.dispatchKeyEvent(event);
     }
 
-    private void edgeToEdgeHandler() {
-        ViewCompat.setOnApplyWindowInsetsListener(this, (v, windowInsets) -> {
-            Insets insets = windowInsets.getInsets(WindowInsetsCompat.Type.systemBars());
+    public void edgeToEdgeHandler(Bridge bridge) {
+        String configEdgeToEdge = bridge.getConfig().adjustMarginsForEdgeToEdge();
 
-            MarginLayoutParams mlp = (MarginLayoutParams) v.getLayoutParams();
-            mlp.leftMargin = insets.left;
-            mlp.bottomMargin = insets.bottom;
-            mlp.rightMargin = insets.right;
-            mlp.topMargin = insets.top;
-            v.setLayoutParams(mlp);
+        if (configEdgeToEdge.equals("disable")) return;
 
-            // Don't pass window insets to children
-            return WindowInsetsCompat.CONSUMED;
-        });
+        boolean autoMargins = false;
+        boolean forceMargins = configEdgeToEdge.equals("force");
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.VANILLA_ICE_CREAM && configEdgeToEdge.equals("auto")) {
+            TypedValue value = new TypedValue();
+            boolean foundOptOut = getContext().getTheme().resolveAttribute(android.R.attr.windowOptOutEdgeToEdgeEnforcement, value, true);
+            boolean optOutValue = value.data != 0; // value is set to -1 on true as of Android 15, so we have to do this.
+
+            autoMargins = !(foundOptOut && optOutValue);
+        }
+
+        if (forceMargins || autoMargins) {
+            ViewCompat.setOnApplyWindowInsetsListener(this, (v, windowInsets) -> {
+                Insets insets = windowInsets.getInsets(WindowInsetsCompat.Type.systemBars());
+                MarginLayoutParams mlp = (MarginLayoutParams) v.getLayoutParams();
+                mlp.leftMargin = insets.left;
+                mlp.bottomMargin = insets.bottom;
+                mlp.rightMargin = insets.right;
+                mlp.topMargin = insets.top;
+                v.setLayoutParams(mlp);
+
+                // Don't pass window insets to children
+                return WindowInsetsCompat.CONSUMED;
+            });
+        }
     }
 }

cli/src/declarations.ts

@@ -297,6 +297,17 @@ export interface CapacitorConfig {
      * @default true
      */
     resolveServiceWorkerRequests?: boolean;
+
+    /**
+     * If set to "force", margins will be adjusted for edge to edge regardless of any other settings.
+     * If set to "auto", or is missing, will check for Android 15 and the setting of [windowOptOutEdgeToEdgeEnforcement](https://developer.android.com/reference/android/R.attr#windowOptOutEdgeToEdgeEnforcement) and will adjust margins if on Android 15 and windowOptOutEdgeToEdgeEnforcement is false/missing.
+     * If set to "disable", will not adjust margins at all.
+     * In Capacitor 8, this default will be changed to 'auto'
+     *
+     * @since 7.1.0
+     * @default disable
+     */
+    adjustMarginsForEdgeToEdge?: 'auto' | 'force' | 'disable';
   };
 
   ios?: {