@capgo/capacitor-inappbrowser 8.10.7 → 8.12.0

package/README.md

@@ -554,6 +554,8 @@ The W3C Payment Request API (used by Google Pay) requires Android WebView 120+.
 * [`addListener('messageFromWebview', ...)`](#addlistenermessagefromwebview-)
 * [`addListener('screenshotTaken', ...)`](#addlistenerscreenshottaken-)
 * [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded-)
+* [`addListener('browserPageLoadStart', ...)`](#addlistenerbrowserpageloadstart-)
+* [`addListener('browserPageLoadProgress', ...)`](#addlistenerbrowserpageloadprogress-)
 * [`addListener('pageLoadError', ...)`](#addlistenerpageloaderror-)
 * [`addListener('customSchemeIntercepted', ...)`](#addlistenercustomschemeintercepted-)
 * [`addListener('downloadCompleted', ...)`](#addlistenerdownloadcompleted-)
@@ -1078,6 +1080,47 @@ Will be triggered when page is loaded
 --------------------
 
 
+### addListener('browserPageLoadStart', ...)
+
+```typescript
+addListener(eventName: 'browserPageLoadStart', listenerFunc: (event: { id?: string; }) => void) => Promise<PluginListenerHandle>
+```
+
+Will be triggered when a main-frame page load starts (link navigation, reload, etc.).
+
+| Param              | Type                                              |
+| ------------------ | ------------------------------------------------- |
+| **`eventName`**    | <code>'browserPageLoadStart'</code>               |
+| **`listenerFunc`** | <code>(event: { id?: string; }) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 8.11.0
+
+--------------------
+
+
+### addListener('browserPageLoadProgress', ...)
+
+```typescript
+addListener(eventName: 'browserPageLoadProgress', listenerFunc: (event: { id?: string; progress: number; }) => void) => Promise<PluginListenerHandle>
+```
+
+Will be triggered as a main-frame page load progresses.
+`progress` is a value from `0` to `1`.
+
+| Param              | Type                                                                |
+| ------------------ | ------------------------------------------------------------------- |
+| **`eventName`**    | <code>'browserPageLoadProgress'</code>                              |
+| **`listenerFunc`** | <code>(event: { id?: string; progress: number; }) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 8.11.0
+
+--------------------
+
+
 ### addListener('pageLoadError', ...)
 
 ```typescript
@@ -1497,6 +1540,7 @@ And in the AndroidManifest.xml file:
 | **`titleIcon`**                        | <code><a href="#toolbartitleiconoptions">ToolbarTitleIconOptions</a></code>                                                                                            | Native toolbar title icon displayed before the title text. For Android: - iconType can be "asset" for a bundled SVG asset or "vector" for a drawable resource - icon path should be in the public folder for assets (e.g. "brand.svg") - width and height are optional and default to 24dp For iOS: - iconType can be "sf-symbol" or "asset" - for sf-symbol, icon should be the symbol name - for asset, icon should be the asset name or bundled web asset path                                                                                                                                                                                                                                                                                                                                                                        |                                                               | 8.7.7  |
 | **`backgroundColor`**                  | <code><a href="#backgroundcolor">BackgroundColor</a></code>                                                                                                            | Background color of the browser                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | <code>BackgroundColor.BLACK</code>                            | 0.1.0  |
 | **`activeNativeNavigationForWebview`** | <code>boolean</code>                                                                                                                                                   | If true, enables native navigation gestures within the webview. - Android: Native back button navigates within webview history - iOS: Enables swipe left/right gestures for back/forward navigation                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | <code>false (Android), true (iOS - enabled by default)</code> |        |
+| **`enableReloadGesture`**              | <code>boolean</code>                                                                                                                                                   | Enable pull-to-refresh (overscroll from top) to reload the current page. - iOS: Uses UIRefreshControl on the WebView scroll view - Android: Uses SwipeRefreshLayout around the WebView On iOS, this requires overscroll bounce. If `disableOverscroll` is `true`, the reload gesture will not work.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | <code>false</code>                                            | 8.10.8 |
 | **`disableGoBackOnNativeApplication`** | <code>boolean</code>                                                                                                                                                   | Disable the possibility to go back on native application, useful to force user to stay on the webview, Android only                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | <code>false</code>                                            |        |
 | **`isPresentAfterPageLoad`**           | <code>boolean</code>                                                                                                                                                   | Open url in a new window fullscreen isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately. Promise timing: on Android, `openWebView()` resolves with the webview id when the webview is ready to be controlled (immediately for hidden/immediate presentation, after the first page load when `isPresentAfterPageLoad` is `true`). On iOS, the promise resolves with the id as soon as the native webview is created, even if presentation is deferred.                                                                                                                                                                                                                                                                                           | <code>false</code>                                            | 0.1.0  |
 | **`isInspectable`**                    | <code>boolean</code>                                                                                                                                                   | Whether the website in the webview is inspectable or not, ios only                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | <code>false</code>                                            |        |

package/android/build.gradle

@@ -60,5 +60,6 @@ dependencies {
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
     implementation "androidx.browser:browser:$androidxBrowserVersion"
     implementation 'com.google.android.material:material:1.13.0'
+    implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0'
     implementation 'androidx.webkit:webkit:1.15.0'
 }

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/CapgoInAppBrowserPlugin.java

@@ -183,6 +183,16 @@ public class CapgoInAppBrowserPlugin extends Plugin implements WebViewDialog.Per
                 notifyListeners("browserPageLoaded", new JSObject().put("id", webViewId));
             }
 
+            @Override
+            public void pageLoadStart() {
+                notifyListeners("browserPageLoadStart", new JSObject().put("id", webViewId));
+            }
+
+            @Override
+            public void pageLoadProgress(double progress) {
+                notifyListeners("browserPageLoadProgress", new JSObject().put("id", webViewId).put("progress", progress));
+            }
+
             @Override
             public void pageLoadError() {
                 notifyListeners("pageLoadError", new JSObject().put("id", webViewId));
@@ -1217,6 +1227,7 @@ public class CapgoInAppBrowserPlugin extends Plugin implements WebViewDialog.Per
         }
 
         options.setActiveNativeNavigationForWebview(Boolean.TRUE.equals(call.getBoolean("activeNativeNavigationForWebview", false)));
+        options.setEnableReloadGesture(Boolean.TRUE.equals(call.getBoolean("enableReloadGesture", false)));
         options.setDisableGoBackOnNativeApplication(Boolean.TRUE.equals(call.getBoolean("disableGoBackOnNativeApplication", false)));
         options.setPresentAfterPageLoad(Boolean.TRUE.equals(call.getBoolean("isPresentAfterPageLoad", false)));
         options.setPluginCall(call);

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/Options.java

@@ -158,6 +158,7 @@ public class Options {
     private String shareSubject;
     private boolean disableGoBackOnNativeApplication;
     private boolean activeNativeNavigationForWebview;
+    private boolean enableReloadGesture = false;
     private boolean isPresentAfterPageLoad;
     private WebViewCallbacks callbacks;
     private PluginCall pluginCall;
@@ -539,6 +540,14 @@ public class Options {
         this.activeNativeNavigationForWebview = activeNativeNavigationForWebview;
     }
 
+    public boolean getEnableReloadGesture() {
+        return enableReloadGesture;
+    }
+
+    public void setEnableReloadGesture(boolean enableReloadGesture) {
+        this.enableReloadGesture = enableReloadGesture;
+    }
+
     public boolean getDisableGoBackOnNativeApplication() {
         return disableGoBackOnNativeApplication;
     }
@@ -763,6 +772,7 @@ public class Options {
         copy.setShareSubject(shareSubject);
         copy.setDisableGoBackOnNativeApplication(disableGoBackOnNativeApplication);
         copy.setActiveNativeNavigationForWebview(activeNativeNavigationForWebview);
+        copy.setEnableReloadGesture(enableReloadGesture);
         copy.setPresentAfterPageLoad(false);
         copy.setVisibleTitle(VisibleTitle);
         copy.setToolbarColor(ToolbarColor);

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/WebViewCallbacks.java

@@ -11,6 +11,10 @@ public interface WebViewCallbacks {
 
     public void pageLoaded();
 
+    public void pageLoadStart();
+
+    public void pageLoadProgress(double progress);
+
     public void pageLoadError();
 
     public void customSchemeIntercepted(String url, boolean opened);

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/WebViewDialog.java

@@ -76,6 +76,7 @@ import androidx.core.graphics.Insets;
 import androidx.core.view.ViewCompat;
 import androidx.core.view.WindowInsetsCompat;
 import androidx.core.view.WindowInsetsControllerCompat;
+import androidx.swiperefreshlayout.widget.SwipeRefreshLayout;
 import androidx.webkit.WebMessageCompat;
 import androidx.webkit.WebSettingsCompat;
 import androidx.webkit.WebViewCompat;
@@ -328,6 +329,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
         }
     }
 
+    private SwipeRefreshLayout swipeRefreshLayout;
     private WebView _webView;
     private Toolbar _toolbar;
     private Options _options = null;
@@ -2171,6 +2173,14 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
 
         this._webView = findViewById(R.id.browser_view);
 
+        this.swipeRefreshLayout = findViewById(R.id.content_browser_layout);
+        if (this.swipeRefreshLayout != null) {
+            boolean enableReloadGesture = _options != null && _options.getEnableReloadGesture();
+            this.swipeRefreshLayout.setEnabled(enableReloadGesture);
+            this.swipeRefreshLayout.setOnRefreshListener(() -> reload());
+            this.swipeRefreshLayout.setOnChildScrollUpCallback((parent, child) -> _webView != null && _webView.canScrollVertically(-1));
+        }
+
         // Apply insets to fix edge-to-edge issues on Android 15+
         applyInsets();
 
@@ -2625,6 +2635,10 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                 public void onProgressChanged(WebView view, int newProgress) {
                     super.onProgressChanged(view, newProgress);
 
+                    if (_options.getCallbacks() != null) {
+                        _options.getCallbacks().pageLoadProgress(newProgress / 100.0);
+                    }
+
                     // When the page is almost loaded, inject our date picker customization
                     // Only if materialPicker option is enabled
                     if (newProgress > 75 && !datePickerInjected && _options.getMaterialPicker()) {
@@ -3801,6 +3815,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
     public void reload() {
         if (_webView == null) {
             Log.w("InAppBrowser", "Cannot reload - WebView is null");
+            stopReloadGesture();
             return;
         }
 
@@ -3820,9 +3835,17 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                 Log.d("InAppBrowser", "Loading initial URL: " + _options.getUrl());
             } else {
                 Log.w("InAppBrowser", "Cannot reload - no valid URL available");
+                stopReloadGesture();
             }
         } catch (Exception e) {
             Log.e("InAppBrowser", "Error during reload: " + e.getMessage());
+            stopReloadGesture();
+        }
+    }
+
+    private void stopReloadGesture() {
+        if (swipeRefreshLayout != null && swipeRefreshLayout.isRefreshing()) {
+            swipeRefreshLayout.setRefreshing(false);
         }
     }
 
@@ -4912,6 +4935,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                     if (_options.getPreventDeeplink()) {
                         Log.d("InAppBrowser", "preventDeeplink is true");
                         if (isNotHttpOrHttps) {
+                            if (request.isForMainFrame()) {
+                                stopReloadGesture();
+                            }
                             return true;
                         }
                     }
@@ -4930,6 +4956,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                             intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
                             context.startActivity(intent);
                             Log.i("InAppBrowser", "Intent started for authorized link: " + url);
+                            if (request.isForMainFrame()) {
+                                stopReloadGesture();
+                            }
                             return true;
                         } catch (ActivityNotFoundException e) {
                             Log.e("InAppBrowser", "No app found to handle this authorized link", e);
@@ -4951,6 +4980,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                             if (shouldEmitCustomSchemeEvent && _options.getCallbacks() != null) {
                                 _options.getCallbacks().customSchemeIntercepted(url, true);
                             }
+                            if (request.isForMainFrame()) {
+                                stopReloadGesture();
+                            }
                             return true;
                         } catch (ActivityNotFoundException e) {
                             Log.w("InAppBrowser", "No handler for external URL: " + url, e);
@@ -4962,6 +4994,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                                 _options.getCallbacks().pageLoadError();
                                 rejectOpenWebViewIfNeeded("No handler available for external URL: " + url);
                             }
+                            if (request.isForMainFrame()) {
+                                stopReloadGesture();
+                            }
                             return true; // prevent WebView from attempting to load the custom scheme
                         } catch (URISyntaxException e) {
                             Log.w("InAppBrowser", "No handler for external URL: " + url, e);
@@ -4970,6 +5005,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                                 _options.getCallbacks().pageLoadError();
                                 rejectOpenWebViewIfNeeded("No handler available for external URL: " + url);
                             }
+                            if (request.isForMainFrame()) {
+                                stopReloadGesture();
+                            }
                             return true; // prevent WebView from attempting to load the custom scheme
                         }
                     }
@@ -4984,6 +5022,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                                 _options.getCallbacks().urlChangeEvent(url);
                             }
                             Log.d("InAppBrowser", "Navigation blocked for URL: " + url);
+                            stopReloadGesture();
                             return true; // Block the navigation
                         }
                     }
@@ -5431,6 +5470,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                     if (view == null || _webView == null) {
                         return;
                     }
+                    if (_options.getCallbacks() != null) {
+                        _options.getCallbacks().pageLoadStart();
+                    }
                     if (ProxyRequestSupport.shouldInjectBridge(_options) && proxyBridgeScript != null && proxyAccessToken != null) {
                         String preparedProxyBridgeScript = prepareProxyBridgeScript();
                         if (preparedProxyBridgeScript != null) {
@@ -5520,6 +5562,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                     updateNavigationButtonsState();
 
                     _options.getCallbacks().pageLoaded();
+                    stopReloadGesture();
                     injectJavaScriptInterface();
 
                     // Inject Google Pay polyfills if enabled
@@ -5537,6 +5580,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
                     if (request == null || !request.isForMainFrame()) {
                         return;
                     }
+                    stopReloadGesture();
                     if (_options.getCallbacks() != null) {
                         _options.getCallbacks().pageLoadError();
                     }

package/android/src/main/res/layout/content_browser.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
+<androidx.swiperefreshlayout.widget.SwipeRefreshLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
     xmlns:tools="http://schemas.android.com/tools"
     android:layout_width="match_parent"
@@ -14,4 +14,4 @@
         android:layout_width="match_parent"
         android:layout_height="match_parent"/>
 
-</RelativeLayout>
+</androidx.swiperefreshlayout.widget.SwipeRefreshLayout>

package/dist/docs.json

@@ -586,6 +586,62 @@
         ],
         "slug": "addlistenerbrowserpageloaded-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'browserPageLoadStart', listenerFunc: (event: { id?: string; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'browserPageLoadStart'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: { id?: string | undefined; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.11.0"
+          }
+        ],
+        "docs": "Will be triggered when a main-frame page load starts (link navigation, reload, etc.).",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerbrowserpageloadstart-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'browserPageLoadProgress', listenerFunc: (event: { id?: string; progress: number; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'browserPageLoadProgress'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: { id?: string | undefined; progress: number; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.11.0"
+          }
+        ],
+        "docs": "Will be triggered as a main-frame page load progresses.\n`progress` is a value from `0` to `1`.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerbrowserpageloadprogress-"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'pageLoadError', listenerFunc: (event: { id?: string; }) => void) => Promise<PluginListenerHandle>",
@@ -1700,6 +1756,26 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "enableReloadGesture",
+          "tags": [
+            {
+              "text": "8.10.8",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "enableReloadGesture: true",
+              "name": "example"
+            }
+          ],
+          "docs": "Enable pull-to-refresh (overscroll from top) to reload the current page.\n- iOS: Uses UIRefreshControl on the WebView scroll view\n- Android: Uses SwipeRefreshLayout around the WebView\n\nOn iOS, this requires overscroll bounce. If `disableOverscroll` is `true`,\nthe reload gesture will not work.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "disableGoBackOnNativeApplication",
           "tags": [

package/dist/esm/definitions.d.ts

@@ -835,6 +835,20 @@ export interface OpenWebViewOptions {
      * Test URL: https://capgo.app
      */
     activeNativeNavigationForWebview?: boolean;
+    /**
+     * Enable pull-to-refresh (overscroll from top) to reload the current page.
+     * - iOS: Uses UIRefreshControl on the WebView scroll view
+     * - Android: Uses SwipeRefreshLayout around the WebView
+     *
+     * On iOS, this requires overscroll bounce. If `disableOverscroll` is `true`,
+     * the reload gesture will not work.
+     *
+     * @since 8.10.8
+     * @default false
+     * @example
+     * enableReloadGesture: true
+     */
+    enableReloadGesture?: boolean;
     /**
      * Disable the possibility to go back on native application,
      * useful to force user to stay on the webview, Android only
@@ -1534,6 +1548,24 @@ export interface InAppBrowserPlugin {
     addListener(eventName: 'browserPageLoaded', listenerFunc: (event: {
         id?: string;
     }) => void): Promise<PluginListenerHandle>;
+    /**
+     * Will be triggered when a main-frame page load starts (link navigation, reload, etc.).
+     *
+     * @since 8.11.0
+     */
+    addListener(eventName: 'browserPageLoadStart', listenerFunc: (event: {
+        id?: string;
+    }) => void): Promise<PluginListenerHandle>;
+    /**
+     * Will be triggered as a main-frame page load progresses.
+     * `progress` is a value from `0` to `1`.
+     *
+     * @since 8.11.0
+     */
+    addListener(eventName: 'browserPageLoadProgress', listenerFunc: (event: {
+        id?: string;
+        progress: number;
+    }) => void): Promise<PluginListenerHandle>;
     /**
      * Will be triggered when page load error
      */