@capgo/capacitor-inappbrowser 8.12.3 → 8.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1539,6 +1539,7 @@ See the README section "openSecureWindow (OAuth)" for full setup examples.
1539
1539
  | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------ |
1540
1540
  | **`url`** | <code>string</code> | Target URL to load. | | 0.1.0 |
1541
1541
  | **`headers`** | <code><a href="#headers">Headers</a></code> | <a href="#headers">Headers</a> to send with the request. | | 0.1.0 |
1542
+ | **`customUserAgent`** | <code>string</code> | Custom User-Agent string for the webview. When set, replaces the system default webview User-Agent on iOS and Android. Takes precedence over a `User-Agent` entry in `headers`. | | 8.13.0 |
1542
1543
  | **`credentials`** | <code><a href="#credentials">Credentials</a></code> | <a href="#credentials">Credentials</a> to send with the request and all subsequent requests for the same host. | | 6.1.0 |
1543
1544
  | **`method`** | <code>string</code> | HTTP method to use for the initial request. **Optional parameter - defaults to GET if not specified.** Existing code that doesn't provide this parameter will continue to work unchanged with standard GET requests. When specified with 'POST', 'PUT', or 'PATCH' methods that support a body, you can also provide a `body` parameter with the request payload. **Platform Notes:** - iOS: Full support for all HTTP methods with headers - Android: Custom headers may not be sent with POST/PUT/PATCH requests due to WebView limitations | <code>"GET"</code> | 8.2.0 |
1544
1545
  | **`body`** | <code>string</code> | HTTP body to send with the request when using POST, PUT, or other methods that support a body. Should be a string (use JSON.stringify for JSON data). **Optional parameter - only used when `method` is specified and supports a request body.** Omitting this parameter (or using GET method) results in standard behavior without a request body. | | 8.2.0 |
@@ -1558,7 +1559,7 @@ See the README section "openSecureWindow (OAuth)" for full setup examples.
1558
1559
  | **`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 |
1559
1560
  | **`backgroundColor`** | <code><a href="#backgroundcolor">BackgroundColor</a></code> | Background color of the browser | <code>BackgroundColor.BLACK</code> | 0.1.0 |
1560
1561
  | **`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> | |
1561
- | **`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 |
1562
+ | **`enableReloadGesture`** | <code>boolean</code> | Enable pull-to-refresh (overscroll from top) to reload the current page. - iOS: Uses UIRefreshControl on the WebView scroll view (reload commits on finger release) - 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 |
1562
1563
  | **`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> | |
1563
1564
  | **`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 |
1564
1565
  | **`isInspectable`** | <code>boolean</code> | Whether the website in the webview is inspectable or not, ios only | <code>false</code> | |
@@ -1029,6 +1029,7 @@ public class CapgoInAppBrowserPlugin extends Plugin implements WebViewDialog.Per
1029
1029
  final Options options = new Options();
1030
1030
  options.setUrl(url);
1031
1031
  options.setHeaders(call.getObject("headers"));
1032
+ options.setCustomUserAgent(call.getString("customUserAgent"));
1032
1033
  options.setCredentials(call.getObject("credentials"));
1033
1034
  options.setShowReloadButton(Boolean.TRUE.equals(call.getBoolean("showReloadButton", false)));
1034
1035
  options.setVisibleTitle(Boolean.TRUE.equals(call.getBoolean("visibleTitle", true)));
@@ -152,6 +152,7 @@ public class Options {
152
152
  private Pattern closeModalURLPattern;
153
153
  private String url;
154
154
  private JSObject headers;
155
+ private String customUserAgent;
155
156
  private JSObject credentials;
156
157
  private String toolbarType;
157
158
  private JSObject shareDisclaimer;
@@ -490,6 +491,14 @@ public class Options {
490
491
  this.headers = headers;
491
492
  }
492
493
 
494
+ public String getCustomUserAgent() {
495
+ return customUserAgent;
496
+ }
497
+
498
+ public void setCustomUserAgent(String customUserAgent) {
499
+ this.customUserAgent = customUserAgent;
500
+ }
501
+
493
502
  public JSObject getCredentials() {
494
503
  return credentials;
495
504
  }
@@ -766,6 +775,7 @@ public class Options {
766
775
  copy.setTitleIcon(titleIcon);
767
776
  copy.setUrl("about:blank");
768
777
  copy.setHeaders(headers);
778
+ copy.setCustomUserAgent(customUserAgent);
769
779
  copy.setCredentials(credentials);
770
780
  copy.setToolbarType(toolbarType);
771
781
  copy.setShareDisclaimer(shareDisclaimer);
@@ -94,4 +94,40 @@ final class SafeAreaInsetsSupport {
94
94
 
95
95
  return fallbackTopInset;
96
96
  }
97
+
98
+ /**
99
+ * Bottom padding to apply to the WebView container (a SwipeRefreshLayout, which honours its own
100
+ * padding but ignores child margins). Combines the resolved safe bottom inset with a compensation
101
+ * term: on Android 15+ the AppBarLayout is pushed down by the status-bar height, which shifts the
102
+ * container's bottom edge off-screen by that same amount, so it must be added back as padding
103
+ * regardless of the safe-margin option.
104
+ */
105
+ static int resolveContainerBottomPadding(
106
+ boolean enabledSafeBottomMargin,
107
+ int safeBottomInset,
108
+ boolean appBarHandlesTopInset,
109
+ int statusBarTop
110
+ ) {
111
+ int base = enabledSafeBottomMargin ? Math.max(0, safeBottomInset) : 0;
112
+ int appBarCompensation = appBarHandlesTopInset ? Math.max(0, statusBarTop) : 0;
113
+ return base + appBarCompensation;
114
+ }
115
+
116
+ /**
117
+ * Top padding for the WebView container. When the AppBarLayout handles the top inset it already
118
+ * sits below the status bar, so no additional padding is needed; otherwise the status-bar height
119
+ * is applied when the safe-top options request it.
120
+ */
121
+ static int resolveContainerTopPadding(
122
+ boolean enabledSafeTopMargin,
123
+ boolean useTopInset,
124
+ int statusBarTop,
125
+ boolean appBarHandlesTopInset
126
+ ) {
127
+ if (appBarHandlesTopInset || !enabledSafeTopMargin || !useTopInset) {
128
+ return 0;
129
+ }
130
+
131
+ return Math.max(0, statusBarTop);
132
+ }
97
133
  }
@@ -330,6 +330,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
330
330
  }
331
331
 
332
332
  private SwipeRefreshLayout swipeRefreshLayout;
333
+ private boolean reloadFromGestureInProgress = false;
333
334
  private WebView _webView;
334
335
  private Toolbar _toolbar;
335
336
  private Options _options = null;
@@ -2177,7 +2178,10 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
2177
2178
  if (this.swipeRefreshLayout != null) {
2178
2179
  boolean enableReloadGesture = _options != null && _options.getEnableReloadGesture();
2179
2180
  this.swipeRefreshLayout.setEnabled(enableReloadGesture);
2180
- this.swipeRefreshLayout.setOnRefreshListener(() -> reload());
2181
+ this.swipeRefreshLayout.setOnRefreshListener(() -> {
2182
+ reloadFromGestureInProgress = true;
2183
+ reload();
2184
+ });
2181
2185
  this.swipeRefreshLayout.setOnChildScrollUpCallback((parent, child) -> _webView != null && _webView.canScrollVertically(-1));
2182
2186
  }
2183
2187
 
@@ -2752,18 +2756,8 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
2752
2756
  });
2753
2757
  }
2754
2758
 
2755
- Map<String, String> requestHeaders = new HashMap<>();
2756
- if (_options.getHeaders() != null) {
2757
- Iterator<String> keys = _options.getHeaders().keys();
2758
- while (keys.hasNext()) {
2759
- String key = keys.next();
2760
- if (TextUtils.equals(key.toLowerCase(), "user-agent")) {
2761
- _webView.getSettings().setUserAgentString(_options.getHeaders().getString(key));
2762
- } else {
2763
- requestHeaders.put(key, _options.getHeaders().getString(key));
2764
- }
2765
- }
2766
- }
2759
+ Map<String, String> requestHeaders = buildRequestHeadersExcludingUserAgent();
2760
+ applyWebViewUserAgent();
2767
2761
 
2768
2762
  // Load URL with optional HTTP method and body
2769
2763
  String httpMethod = _options.getHttpMethod();
@@ -2773,7 +2767,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
2773
2767
  if (loadHtmlDataUrlIfNeeded(this._options.getUrl())) {
2774
2768
  // Inline HTML loaded from data:text/html;base64 URL.
2775
2769
  } else if (shouldBootstrapInitialLegacyProxyLoad()) {
2776
- loadInitialLegacyProxyContent(requestHeaders, httpMethod, httpBody);
2770
+ loadInitialLegacyProxyContent(requestHeaders, buildRequestHeadersForNativeProxy(requestHeaders), httpMethod, httpBody);
2777
2771
  } else if (supportsRequestBody(httpMethod) && httpBody != null) {
2778
2772
  // For POST/PUT/PATCH requests with body
2779
2773
  // Note: Android WebView has limitations with custom headers on POST
@@ -3153,6 +3147,9 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
3153
3147
  }
3154
3148
 
3155
3149
  requestSafeAreaInsets();
3150
+
3151
+ mainHandler.postDelayed(this::applyContainerInsetsSnapshot, 300);
3152
+ mainHandler.postDelayed(this::applyContainerInsetsSnapshot, 1200);
3156
3153
  }
3157
3154
 
3158
3155
  private void applySafeAreaMargins(
@@ -3208,6 +3205,76 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
3208
3205
  mlp.rightMargin = bars.right;
3209
3206
  _webView.setLayoutParams(mlp);
3210
3207
  injectSafeAreaCssVariables(navTop, bottomMargin, bars.left, bars.right);
3208
+ applyContainerInsetsSnapshot();
3209
+ }
3210
+
3211
+ private void applyContainerInsetsSnapshot() {
3212
+ if (_options == null || _webView == null) {
3213
+ return;
3214
+ }
3215
+
3216
+ View container = findViewById(R.id.content_browser_layout);
3217
+ if (container == null) {
3218
+ return;
3219
+ }
3220
+
3221
+ Window window = getWindow();
3222
+ View decorView = window != null ? window.getDecorView() : null;
3223
+ WindowInsetsCompat windowInsets = decorView != null ? ViewCompat.getRootWindowInsets(decorView) : null;
3224
+
3225
+ Insets bars = windowInsets != null ? windowInsets.getInsets(WindowInsetsCompat.Type.systemBars()) : Insets.NONE;
3226
+ Insets navigationBars = windowInsets != null ? windowInsets.getInsets(WindowInsetsCompat.Type.navigationBars()) : Insets.NONE;
3227
+ Insets systemGestures = windowInsets != null ? windowInsets.getInsets(WindowInsetsCompat.Type.systemGestures()) : Insets.NONE;
3228
+ Insets mandatoryGestures =
3229
+ windowInsets != null ? windowInsets.getInsets(WindowInsetsCompat.Type.mandatorySystemGestures()) : Insets.NONE;
3230
+
3231
+ boolean isAndroid15Plus = Build.VERSION.SDK_INT >= 35;
3232
+ View toolbarView = findViewById(R.id.tool_bar);
3233
+ boolean appBarHandlesTopInset =
3234
+ isAndroid15Plus &&
3235
+ !TextUtils.equals(_options.getToolbarType(), "blank") &&
3236
+ toolbarView != null &&
3237
+ toolbarView.getVisibility() == View.VISIBLE &&
3238
+ toolbarView.getParent() instanceof com.google.android.material.appbar.AppBarLayout;
3239
+
3240
+ int statusBarTop = bars.top > 0 ? bars.top : getSystemStatusBarHeight();
3241
+ int fallbackBottomInset = _options.getEnabledSafeMargin() ? getSystemNavigationBarHeight() : 0;
3242
+ int safeBottomInset = SafeAreaInsetsSupport.resolveSafeBottomInsetWithFallback(
3243
+ bars.bottom,
3244
+ navigationBars.bottom,
3245
+ systemGestures.bottom,
3246
+ mandatoryGestures.bottom,
3247
+ bars.left,
3248
+ bars.right,
3249
+ navigationBars.left,
3250
+ navigationBars.right,
3251
+ fallbackBottomInset,
3252
+ _options.getEnabledSafeMargin()
3253
+ );
3254
+
3255
+ int padTop = SafeAreaInsetsSupport.resolveContainerTopPadding(
3256
+ _options.getEnabledSafeTopMargin(),
3257
+ _options.getUseTopInset(),
3258
+ statusBarTop,
3259
+ appBarHandlesTopInset
3260
+ );
3261
+ int padBottom = SafeAreaInsetsSupport.resolveContainerBottomPadding(
3262
+ _options.getEnabledSafeMargin(),
3263
+ safeBottomInset,
3264
+ appBarHandlesTopInset,
3265
+ statusBarTop
3266
+ );
3267
+
3268
+ if (
3269
+ container.getPaddingLeft() == bars.left &&
3270
+ container.getPaddingTop() == padTop &&
3271
+ container.getPaddingRight() == bars.right &&
3272
+ container.getPaddingBottom() == padBottom
3273
+ ) {
3274
+ return;
3275
+ }
3276
+
3277
+ container.setPadding(bars.left, padTop, bars.right, padBottom);
3211
3278
  }
3212
3279
 
3213
3280
  private void configureBlankToolbarLayout() {
@@ -3291,7 +3358,10 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
3291
3358
  }
3292
3359
 
3293
3360
  ViewCompat.requestApplyInsets(insetsSourceView);
3294
- insetsSourceView.post(() -> ViewCompat.requestApplyInsets(insetsSourceView));
3361
+ insetsSourceView.post(() -> {
3362
+ ViewCompat.requestApplyInsets(insetsSourceView);
3363
+ applyContainerInsetsSnapshot();
3364
+ });
3295
3365
  }
3296
3366
 
3297
3367
  public void postMessageToJS(Object detail) {
@@ -3844,9 +3914,30 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
3844
3914
  }
3845
3915
 
3846
3916
  private void stopReloadGesture() {
3917
+ boolean shouldResetScroll = reloadFromGestureInProgress;
3918
+ reloadFromGestureInProgress = false;
3919
+
3847
3920
  if (swipeRefreshLayout != null && swipeRefreshLayout.isRefreshing()) {
3848
3921
  swipeRefreshLayout.setRefreshing(false);
3849
3922
  }
3923
+
3924
+ // Only reset scroll after a gesture reload. Ordinary page loads / intercepted navigations
3925
+ // also call stopReloadGesture and must not jump the WebView to the top.
3926
+ if (!shouldResetScroll || _webView == null) {
3927
+ return;
3928
+ }
3929
+
3930
+ // Sticky scrollY after reload makes canScrollVertically(-1) true, which blocks the next pull
3931
+ // via setOnChildScrollUpCallback until a full document navigation resets scroll state.
3932
+ final WebView webView = _webView;
3933
+ webView.post(() -> {
3934
+ if (_webView != webView) {
3935
+ return;
3936
+ }
3937
+ if (webView.getScrollY() != 0) {
3938
+ webView.scrollTo(webView.getScrollX(), 0);
3939
+ }
3940
+ });
3850
3941
  }
3851
3942
 
3852
3943
  public void destroy() {
@@ -3908,6 +3999,65 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
3908
3999
  }
3909
4000
  }
3910
4001
 
4002
+ private String resolveWebViewUserAgent() {
4003
+ if (_options == null) {
4004
+ return null;
4005
+ }
4006
+
4007
+ if (!TextUtils.isEmpty(_options.getCustomUserAgent())) {
4008
+ return _options.getCustomUserAgent();
4009
+ }
4010
+
4011
+ if (_options.getHeaders() != null) {
4012
+ Iterator<String> keys = _options.getHeaders().keys();
4013
+ while (keys.hasNext()) {
4014
+ String key = keys.next();
4015
+ if (TextUtils.equals(key.toLowerCase(), "user-agent")) {
4016
+ return _options.getHeaders().getString(key);
4017
+ }
4018
+ }
4019
+ }
4020
+
4021
+ return null;
4022
+ }
4023
+
4024
+ private Map<String, String> buildRequestHeadersExcludingUserAgent() {
4025
+ Map<String, String> requestHeaders = new HashMap<>();
4026
+ if (_options == null || _options.getHeaders() == null) {
4027
+ return requestHeaders;
4028
+ }
4029
+
4030
+ Iterator<String> keys = _options.getHeaders().keys();
4031
+ while (keys.hasNext()) {
4032
+ String key = keys.next();
4033
+ if (TextUtils.equals(key.toLowerCase(), "user-agent")) {
4034
+ continue;
4035
+ }
4036
+ requestHeaders.put(key, _options.getHeaders().getString(key));
4037
+ }
4038
+ return requestHeaders;
4039
+ }
4040
+
4041
+ private void applyWebViewUserAgent() {
4042
+ if (_webView == null) {
4043
+ return;
4044
+ }
4045
+
4046
+ String userAgent = resolveWebViewUserAgent();
4047
+ if (!TextUtils.isEmpty(userAgent)) {
4048
+ _webView.getSettings().setUserAgentString(userAgent);
4049
+ }
4050
+ }
4051
+
4052
+ private Map<String, String> buildRequestHeadersForNativeProxy(Map<String, String> requestHeaders) {
4053
+ Map<String, String> proxyHeaders = new HashMap<>(requestHeaders);
4054
+ String userAgent = resolveWebViewUserAgent();
4055
+ if (!TextUtils.isEmpty(userAgent)) {
4056
+ proxyHeaders.put("User-Agent", userAgent);
4057
+ }
4058
+ return proxyHeaders;
4059
+ }
4060
+
3911
4061
  public void setUrl(String url) {
3912
4062
  if (_webView == null) {
3913
4063
  Log.w("InAppBrowser", "Cannot set URL - WebView is null");
@@ -3924,18 +4074,8 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
3924
4074
  return;
3925
4075
  }
3926
4076
 
3927
- Map<String, String> requestHeaders = new HashMap<>();
3928
- if (_options.getHeaders() != null) {
3929
- Iterator<String> keys = _options.getHeaders().keys();
3930
- while (keys.hasNext()) {
3931
- String key = keys.next();
3932
- if (TextUtils.equals(key.toLowerCase(), "user-agent")) {
3933
- _webView.getSettings().setUserAgentString(_options.getHeaders().getString(key));
3934
- } else {
3935
- requestHeaders.put(key, _options.getHeaders().getString(key));
3936
- }
3937
- }
3938
- }
4077
+ Map<String, String> requestHeaders = buildRequestHeadersExcludingUserAgent();
4078
+ applyWebViewUserAgent();
3939
4079
  _webView.loadUrl(url, requestHeaders);
3940
4080
  } catch (Exception e) {
3941
4081
  Log.e("InAppBrowser", "Error setting URL: " + e.getMessage());
@@ -6109,9 +6249,16 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
6109
6249
  _webView.loadUrl(_options.getUrl(), headers);
6110
6250
  }
6111
6251
 
6112
- private void loadInitialLegacyProxyContent(Map<String, String> requestHeaders, String httpMethod, String httpBody) {
6252
+ private void loadInitialLegacyProxyContent(
6253
+ Map<String, String> directRequestHeaders,
6254
+ Map<String, String> proxyRequestHeaders,
6255
+ String httpMethod,
6256
+ String httpBody
6257
+ ) {
6113
6258
  final String initialUrl = _options.getUrl();
6114
- final Map<String, String> initialHeaders = requestHeaders != null ? new HashMap<>(requestHeaders) : new HashMap<>();
6259
+ final Map<String, String> initialDirectHeaders =
6260
+ directRequestHeaders != null ? new HashMap<>(directRequestHeaders) : new HashMap<>();
6261
+ final Map<String, String> initialProxyHeaders = proxyRequestHeaders != null ? new HashMap<>(proxyRequestHeaders) : new HashMap<>();
6115
6262
  final String initialMethod = httpMethod != null && !httpMethod.isBlank() ? httpMethod : "GET";
6116
6263
  final String initialBody =
6117
6264
  supportsRequestBody(initialMethod) && httpBody != null
@@ -6122,7 +6269,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
6122
6269
  NativeRequestContext requestContext = new NativeRequestContext(
6123
6270
  initialUrl,
6124
6271
  initialMethod,
6125
- initialHeaders,
6272
+ initialProxyHeaders,
6126
6273
  initialBody,
6127
6274
  true,
6128
6275
  "same-origin"
@@ -6140,7 +6287,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
6140
6287
  if (_webView == null) {
6141
6288
  return;
6142
6289
  }
6143
- _webView.post(() -> loadInitialUrlDirect(initialHeaders, initialMethod, httpBody));
6290
+ _webView.post(() -> loadInitialUrlDirect(initialDirectHeaders, initialMethod, httpBody));
6144
6291
  return;
6145
6292
  }
6146
6293
 
package/dist/docs.json CHANGED
@@ -1430,6 +1430,22 @@
1430
1430
  ],
1431
1431
  "type": "Headers"
1432
1432
  },
1433
+ {
1434
+ "name": "customUserAgent",
1435
+ "tags": [
1436
+ {
1437
+ "text": "8.13.0",
1438
+ "name": "since"
1439
+ },
1440
+ {
1441
+ "text": "customUserAgent: \"MyApp/1.0 (Capacitor)\"\nTest URL: https://www.whatismybrowser.com/detect/what-is-my-user-agent/",
1442
+ "name": "example"
1443
+ }
1444
+ ],
1445
+ "docs": "Custom User-Agent string for the webview.\n\nWhen set, replaces the system default webview User-Agent on iOS and Android.\nTakes precedence over a `User-Agent` entry in `headers`.",
1446
+ "complexTypes": [],
1447
+ "type": "string | undefined"
1448
+ },
1433
1449
  {
1434
1450
  "name": "credentials",
1435
1451
  "tags": [
@@ -1772,7 +1788,7 @@
1772
1788
  "name": "example"
1773
1789
  }
1774
1790
  ],
1775
- "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.",
1791
+ "docs": "Enable pull-to-refresh (overscroll from top) to reload the current page.\n- iOS: Uses UIRefreshControl on the WebView scroll view (reload commits on finger release)\n- Android: Uses SwipeRefreshLayout around the WebView\n\nOn iOS, this requires overscroll bounce. If `disableOverscroll` is `true`,\nthe reload gesture will not work.",
1776
1792
  "complexTypes": [],
1777
1793
  "type": "boolean | undefined"
1778
1794
  },
@@ -610,6 +610,18 @@ export interface OpenWebViewOptions {
610
610
  * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/
611
611
  */
612
612
  headers?: Headers;
613
+ /**
614
+ * Custom User-Agent string for the webview.
615
+ *
616
+ * When set, replaces the system default webview User-Agent on iOS and Android.
617
+ * Takes precedence over a `User-Agent` entry in `headers`.
618
+ *
619
+ * @since 8.13.0
620
+ * @example
621
+ * customUserAgent: "MyApp/1.0 (Capacitor)"
622
+ * Test URL: https://www.whatismybrowser.com/detect/what-is-my-user-agent/
623
+ */
624
+ customUserAgent?: string;
613
625
  /**
614
626
  * Credentials to send with the request and all subsequent requests for the same host.
615
627
  * @since 6.1.0
@@ -837,7 +849,7 @@ export interface OpenWebViewOptions {
837
849
  activeNativeNavigationForWebview?: boolean;
838
850
  /**
839
851
  * Enable pull-to-refresh (overscroll from top) to reload the current page.
840
- * - iOS: Uses UIRefreshControl on the WebView scroll view
852
+ * - iOS: Uses UIRefreshControl on the WebView scroll view (reload commits on finger release)
841
853
  * - Android: Uses SwipeRefreshLayout around the WebView
842
854
  *
843
855
  * On iOS, this requires overscroll bounce. If `disableOverscroll` is `true`,
@@ -1 +1 @@
1
- {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAmEA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AACD,MAAM,CAAN,IAAY,WAqBX;AArBD,WAAY,WAAW;IACrB;;;OAGG;IACH,oCAAqB,CAAA;IACrB;;;OAGG;IACH,kCAAmB,CAAA;IACnB;;;OAGG;IACH,wCAAyB,CAAA;IACzB;;;OAGG;IACH,8BAAe,CAAA;AACjB,CAAC,EArBW,WAAW,KAAX,WAAW,QAqBtB;AAED,MAAM,CAAN,IAAY,gBASX;AATD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,mCAAe,CAAA;IACf;;OAEG;IACH,iDAA6B,CAAA;AAC/B,CAAC,EATW,gBAAgB,KAAhB,gBAAgB,QAS3B;AAED,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB;;OAEG;IACH,8BAAe,CAAA;IACf;;OAEG;IACH,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,KAAX,WAAW,QAStB","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface UrlEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * Emit when the url changes\n *\n * @since 0.0.1\n */\n url: string;\n}\n\n/**\n * Event emitted when the managed webview intercepts a non-standard custom scheme\n * and hands it to the operating system.\n *\n * Standard OS-handled schemes such as `tel:`, `mailto:`, and `sms:` are excluded.\n *\n * @since 8.6.7\n */\nexport interface CustomSchemeInterceptedEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * Intercepted URL.\n */\n url: string;\n /**\n * Whether the operating system accepted the URL handoff.\n */\n opened: boolean;\n}\nexport interface BtnEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * Emit when a button is clicked.\n *\n * @since 0.0.1\n */\n url: string;\n}\n\nexport interface ButtonNearDoneEvent {\n /**\n * Webview instance id.\n *\n * @since 8.6.36\n */\n id: string;\n}\n\nexport type UrlChangeListener = (state: UrlEvent) => void;\nexport type ConfirmBtnListener = (state: BtnEvent) => void;\nexport type ButtonNearListener = (state: ButtonNearDoneEvent) => void;\nexport type CustomSchemeInterceptedListener = (state: CustomSchemeInterceptedEvent) => void;\n\nexport type WebViewPointerInputEventType = 'click' | 'touchstart' | 'touchmove' | 'touchend' | 'touchcancel';\nexport type WebViewInputEventType = WebViewPointerInputEventType | 'scroll';\n\nexport enum BackgroundColor {\n WHITE = 'white',\n BLACK = 'black',\n}\nexport enum ToolBarType {\n /**\n * Shows a simple toolbar with just a close button and share button\n * @since 0.1.0\n */\n ACTIVITY = 'activity',\n /**\n * Shows a simple toolbar with just a close button\n * @since 7.6.8\n */\n COMPACT = 'compact',\n /**\n * Shows a full navigation toolbar with back/forward buttons\n * @since 0.1.0\n */\n NAVIGATION = 'navigation',\n /**\n * Shows no toolbar\n * @since 0.1.0\n */\n BLANK = 'blank',\n}\n\nexport enum InvisibilityMode {\n /**\n * WebView is aware it is hidden (dimensions may be zero).\n */\n AWARE = 'AWARE',\n /**\n * WebView is hidden but reports fullscreen dimensions (uses alpha=0 to remain invisible).\n */\n FAKE_VISIBLE = 'FAKE_VISIBLE',\n}\n\nexport enum CloseAction {\n /**\n * The toolbar close button closes and destroys the webview.\n */\n CLOSE = 'close',\n /**\n * The toolbar close button hides the webview so it can be shown again.\n */\n HIDE = 'hide',\n}\n\nexport interface ToolbarTitleIconOptions {\n ios?: {\n iconType: 'sf-symbol' | 'asset';\n icon: string;\n };\n android?: {\n iconType: 'asset' | 'vector';\n icon: string;\n width?: number;\n height?: number;\n };\n}\n\nexport interface Headers {\n [key: string]: string;\n}\n\nexport interface GetCookieOptions {\n url: string;\n includeHttpOnly?: boolean;\n}\n\nexport interface ClearCookieOptions {\n /**\n * Target webview id.\n * When omitted, applies to all open webviews.\n */\n id?: string;\n url: string;\n}\n\nexport interface Credentials {\n username: string;\n password: string;\n}\n\nexport interface LayerOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Makes the Capacitor host WebView transparent while this native webview is behind it.\n *\n * @default true\n */\n transparentBackground?: boolean;\n}\n\nexport interface BringToFrontOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Whether bringing the webview to the front is animated on iOS.\n *\n * @default true\n */\n isAnimated?: boolean;\n}\n\nexport interface DispatchPointerInputEventOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Input event to dispatch to the webview.\n */\n type: WebViewPointerInputEventType;\n /**\n * X coordinate in CSS pixels from the webview's left edge.\n */\n x: number;\n /**\n * Y coordinate in CSS pixels from the webview's top edge.\n */\n y: number;\n}\n\nexport interface DispatchScrollInputEventOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Input event to dispatch to the webview.\n */\n type: 'scroll';\n /**\n * X coordinate in CSS pixels from the webview's left edge.\n */\n x: number;\n /**\n * Y coordinate in CSS pixels from the webview's top edge.\n */\n y: number;\n /**\n * Horizontal scroll delta in CSS pixels. Used when `type` is `scroll`.\n */\n deltaX: number;\n /**\n * Vertical scroll delta in CSS pixels. Used when `type` is `scroll`.\n */\n deltaY: number;\n}\n\nexport type DispatchInputEventOptions = DispatchPointerInputEventOptions | DispatchScrollInputEventOptions;\n\n/**\n * Represents an intercepted HTTP request from the in-app browser webview.\n *\n * Request and response bodies are base64-encoded when present.\n *\n * @since 8.6.0\n */\nexport interface ProxyRequest {\n requestId: string;\n phase: 'outbound' | 'inbound';\n url: string;\n method: string;\n headers: Record<string, string>;\n body: string | null;\n status?: number;\n responseHeaders?: Record<string, string>;\n responseBody?: string | null;\n webviewId: string;\n}\n\n/**\n * Response payload returned to native for a proxied request.\n *\n * The body must be base64-encoded.\n *\n * @since 8.6.0\n */\nexport interface ProxyResponse {\n body: string;\n status: number;\n headers: Record<string, string>;\n}\n\n/**\n * Request override returned to native for an outbound proxied request.\n *\n * The body must be base64-encoded when present.\n *\n * @since 8.6.0\n */\nexport interface ProxyRequestOverride {\n url: string;\n method?: string;\n headers?: Record<string, string>;\n body?: string | null;\n}\n\n/**\n * Event emitted when a web page opens a popup/new window.\n *\n * @since 8.6.0\n */\nexport interface PopupWindowEvent {\n /**\n * Popup webview instance id.\n */\n id: string;\n /**\n * Parent webview instance id.\n */\n parentId?: string;\n /**\n * Requested popup URL when available.\n */\n url?: string;\n /**\n * Whether the popup was presented immediately.\n */\n visible: boolean;\n}\n\n/**\n * Event emitted when JavaScript running inside the managed webview writes to the console.\n *\n * Enable this with `captureConsoleLogs: true` when opening the webview.\n *\n * @since 8.6.0\n */\nexport interface ConsoleMessageEvent {\n /**\n * Source webview instance id.\n */\n id?: string;\n /**\n * Console method or normalized severity.\n */\n level: 'log' | 'info' | 'warn' | 'error' | 'debug' | 'assert' | string;\n /**\n * Joined string representation of the console arguments.\n */\n message: string;\n /**\n * Script URL or page URL when available.\n */\n source?: string;\n /**\n * 1-based line number when available.\n */\n line?: number;\n /**\n * 1-based column number when available.\n */\n column?: number;\n /**\n * Optional subtype for runtime-originated errors on supported platforms.\n */\n kind?: string;\n}\n\n/**\n * Native handling mode used after a managed download finishes.\n *\n * @since 8.6.0\n */\nexport type DownloadHandledBy = 'inAppBrowser' | 'systemPreview' | 'external';\n\n/**\n * Event emitted after a managed download is saved locally.\n *\n * @since 8.6.0\n */\nexport interface DownloadCompletedEvent {\n /**\n * Source webview instance id.\n */\n id?: string;\n /**\n * Original URL that triggered the download when available.\n */\n sourceUrl?: string;\n /**\n * Saved filename.\n */\n fileName: string;\n /**\n * Resolved MIME type when available.\n */\n mimeType?: string;\n /**\n * Absolute native filesystem path to the saved file.\n */\n path: string;\n /**\n * `file://` URL pointing at the saved file.\n */\n localUrl: string;\n /**\n * How native handled the downloaded file after saving it.\n */\n handledBy: DownloadHandledBy;\n}\n\n/**\n * Event emitted when managed download handling fails.\n *\n * @since 8.6.0\n */\nexport interface DownloadFailedEvent {\n /**\n * Source webview instance id.\n */\n id?: string;\n /**\n * Original URL that triggered the download when available.\n */\n sourceUrl?: string;\n /**\n * Intended filename when known.\n */\n fileName?: string;\n /**\n * Resolved MIME type when available.\n */\n mimeType?: string;\n /**\n * Native error message.\n */\n error: string;\n}\n\n/**\n * Decision returned to native when handling a proxied request.\n *\n * @since 8.6.0\n */\nexport interface ProxyDecision {\n request?: ProxyRequestOverride | null;\n response?: ProxyResponse | null;\n cancel?: boolean;\n}\n\n/**\n * Native-first proxy rule used on Android and iOS.\n *\n * Any regex property that is omitted is treated as a wildcard.\n *\n * @since 8.6.0\n */\nexport interface NativeProxyRule {\n id?: string;\n urlRegex?: string;\n methodRegex?: string;\n headerRegex?: string;\n bodyRegex?: string;\n statusRegex?: string;\n responseHeaderRegex?: string;\n responseBodyRegex?: string;\n mainFrameOnly?: boolean;\n action: 'continue' | 'cancel' | 'delegateToJs';\n}\n\nexport type ProxyHandlerResult = Response | ProxyResponse | ProxyRequestOverride | ProxyDecision | null;\n\n/**\n * JavaScript callback used to handle proxied requests.\n *\n * Return a `Response`, `ProxyResponse`, `ProxyRequestOverride`, `ProxyDecision`,\n * or `null` to let native continue unchanged.\n *\n * @since 8.6.0\n */\nexport type ProxyHandler = (request: ProxyRequest) => ProxyHandlerResult | Promise<ProxyHandlerResult>;\n\nexport interface OpenOptions {\n /**\n * Target URL to load.\n * @since 0.1.0\n */\n url: string;\n /**\n * if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n * @since 0.1.0\n */\n isPresentAfterPageLoad?: boolean;\n /**\n * if true the deeplink will not be opened, if false the deeplink will be opened when clicked on the link\n * @since 0.1.0\n */\n preventDeeplink?: boolean;\n\n // --- Chrome Custom Tab customization (Android only, ignored on iOS) ---\n\n /**\n * Toolbar background color in hex format (e.g., \"#1A1A2E\").\n * Applied to both light and dark color schemes.\n * Also sets the navigation bar color to match.\n * **Android only** — ignored on iOS.\n * @since 8.2.0\n */\n toolbarColor?: string;\n\n /**\n * Whether the URL bar should auto-hide when the user scrolls down.\n * The bar reappears on any upward scroll.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n urlBarHidingEnabled?: boolean;\n\n /**\n * Show the page's HTML <title> in the toolbar instead of the raw URL.\n * The true URL is still visible when the user taps the title area.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n showTitle?: boolean;\n\n /**\n * Replace the default \"X\" close icon with a back arrow.\n * Makes the Custom Tab feel like a native navigation push rather than a modal overlay.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n showArrow?: boolean;\n\n /**\n * Remove the share action from the overflow menu.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n disableShare?: boolean;\n\n /**\n * Hide the bookmark star icon in the overflow menu.\n * Uses an undocumented Chromium intent extra — may stop working on future Chrome updates.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n disableBookmark?: boolean;\n\n /**\n * Hide the download icon in the overflow menu.\n * Uses an undocumented Chromium intent extra — may stop working on future Chrome updates.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n disableDownload?: boolean;\n}\n\nexport interface OpenSecureWindowOptions {\n /**\n * The endpoint to open\n */\n authEndpoint: string;\n /**\n * The redirect URI to use for the openSecureWindow call.\n * This will be checked to make sure it matches the redirect URI after the window finishes the redirection.\n */\n redirectUri: string;\n /**\n * The name of the broadcast channel to listen to, relevant only for web\n */\n broadcastChannelName?: string;\n /**\n * If true, the browser session will be ephemeral (no cookies or browsing data are shared with the system browser).\n * On iOS, this sets `prefersEphemeralWebBrowserSession = true` on `ASWebAuthenticationSession`.\n * On Android, this enables Custom Tabs ephemeral browsing via `setEphemeralBrowsingEnabled(true)`.\n * @default false\n * @since 6.6.0\n */\n prefersEphemeralWebBrowserSession?: boolean;\n}\n\nexport interface OpenSecureWindowResponse {\n /**\n * The result of the openSecureWindow call\n */\n redirectedUri: string;\n}\n\nexport interface DisclaimerOptions {\n /**\n * Title of the disclaimer dialog\n * @default \"Title\"\n */\n title: string;\n /**\n * Message shown in the disclaimer dialog\n * @default \"Message\"\n */\n message: string;\n /**\n * Text for the confirm button\n * @default \"Confirm\"\n */\n confirmBtn: string;\n /**\n * Text for the cancel button\n * @default \"Cancel\"\n */\n cancelBtn: string;\n}\n\nexport interface ScreenshotResult {\n /**\n * Image format used for the screenshot.\n */\n format: 'png';\n /**\n * MIME type of the generated screenshot.\n */\n mimeType: 'image/png';\n /**\n * Base64-encoded screenshot payload without the data URL prefix.\n */\n base64: string;\n /**\n * Data URL for direct use in HTML img tags or uploads.\n */\n dataUrl: string;\n /**\n * Screenshot width in pixels.\n */\n width: number;\n /**\n * Screenshot height in pixels.\n */\n height: number;\n}\n\nexport interface HideEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * URL active when the webview was hidden.\n */\n url: string;\n /**\n * Screenshot captured immediately before the toolbar close button hides the webview.\n * Present only when `screenshotOnHide` is enabled and capture succeeds.\n */\n screenshot?: ScreenshotResult;\n}\n\nexport type HideListener = (state: HideEvent) => void;\n\nexport interface CloseWebviewOptions {\n /**\n * Target webview id to close. If omitted, closes the active webview.\n */\n id?: string;\n /**\n * Whether the webview closing is animated or not, ios only\n * @default true\n */\n isAnimated?: boolean;\n}\n\nexport interface OpenWebViewOptions {\n /**\n * Target URL to load.\n * @since 0.1.0\n * @example \"https://capgo.app\"\n */\n url: string;\n /**\n * Headers to send with the request.\n * @since 0.1.0\n * @example\n * headers: {\n * \"Custom-Header\": \"test-value\",\n * \"Authorization\": \"Bearer test-token\"\n * }\n * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n */\n headers?: Headers;\n /**\n * Credentials to send with the request and all subsequent requests for the same host.\n * @since 6.1.0\n * @example\n * credentials: {\n * username: \"test-user\",\n * password: \"test-pass\"\n * }\n * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n */\n credentials?: Credentials;\n /**\n * HTTP method to use for the initial request.\n *\n * **Optional parameter - defaults to GET if not specified.**\n * Existing code that doesn't provide this parameter will continue to work unchanged with standard GET requests.\n *\n * When specified with 'POST', 'PUT', or 'PATCH' methods that support a body,\n * you can also provide a `body` parameter with the request payload.\n *\n * **Platform Notes:**\n * - iOS: Full support for all HTTP methods with headers\n * - Android: Custom headers may not be sent with POST/PUT/PATCH requests due to WebView limitations\n *\n * @since 8.2.0\n * @default \"GET\"\n * @example\n * method: \"POST\",\n * body: JSON.stringify({ token: \"auth-token\", data: \"value\" }),\n * headers: { \"Content-Type\": \"application/json\" }\n */\n method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | string;\n /**\n * HTTP body to send with the request when using POST, PUT, or other methods that support a body.\n * Should be a string (use JSON.stringify for JSON data).\n *\n * **Optional parameter - only used when `method` is specified and supports a request body.**\n * Omitting this parameter (or using GET method) results in standard behavior without a request body.\n *\n * @since 8.2.0\n * @example\n * method: \"POST\",\n * body: JSON.stringify({ username: \"user\", password: \"pass\" }),\n * headers: { \"Content-Type\": \"application/json\" }\n */\n body?: string;\n /**\n * materialPicker: if true, uses Material Design theme for date and time pickers on Android.\n * This improves the appearance of HTML date inputs to use modern Material Design UI instead of the old style pickers.\n * @since 7.4.1\n * @default false\n * @example\n * materialPicker: true\n * Test URL: https://show-picker.glitch.me/demo.html\n */\n materialPicker?: boolean;\n /**\n * JavaScript Interface:\n * The webview automatically injects a JavaScript interface providing:\n * - `window.mobileApp.close()`: Closes the webview from JavaScript\n * - `window.mobileApp.postMessage(obj)`: Sends a message to the app (listen via \"messageFromWebview\" event)\n * - `window.mobileApp.hide()` / `window.mobileApp.show()` when allowWebViewJsVisibilityControl is true in CapacitorConfig\n * - `window.mobileApp.takeScreenshot()` when `allowScreenshotsFromWebPage` is true\n *\n * @example\n * // In your webpage loaded in the webview:\n * document.getElementById(\"closeBtn\").addEventListener(\"click\", () => {\n * window.mobileApp.close();\n * });\n *\n * // Send data to the app\n * window.mobileApp.postMessage({ action: \"login\", data: { user: \"test\" }});\n *\n * @since 6.10.0\n */\n jsInterface?: never; // This property doesn't exist, it's just for documentation\n /**\n * Allows page JavaScript to call `window.mobileApp.takeScreenshot()`.\n * Disabled by default so only the host app can trigger native screenshots through the plugin API.\n *\n * @default false\n * @since 8.4.0\n */\n allowScreenshotsFromWebPage?: boolean;\n /**\n * Emits `consoleMessage` events for JavaScript `console.*` output coming from the managed page.\n * Useful when the webview stays hidden and you still need page-level diagnostics.\n *\n * @default false\n * @since 8.6.0\n */\n captureConsoleLogs?: boolean;\n /**\n * Controls whether the webview should persist website data such as cache, cookies, local storage,\n * IndexedDB, and session data.\n *\n * When false, iOS uses a non-persistent `WKWebsiteDataStore`. Android disables per-view cache and\n * DOM/database storage where the system WebView supports it. Android cookies use the shared\n * WebView cookie store, so call `clearAllBrowsingData()` to remove cookies and other global data.\n *\n * @default true\n * @since 8.6.36\n */\n persistWebViewData?: boolean;\n /**\n * Controls Android TLS client certificate prompts during HTTPS handshakes.\n * Use `prompt` to show the system certificate picker; omit or use `none` to cancel silently (default).\n *\n * @default \"none\"\n * @since 8.7.5\n */\n clientCertificate?: 'none' | 'prompt';\n /**\n * @deprecated Use `clientCertificate: \"prompt\"` instead.\n */\n clientCertificatePrompt?: boolean;\n /**\n * Automatically handles downloads triggered inside the webview without requiring a custom JavaScript bridge.\n *\n * When enabled:\n * - Standard attachment responses are written to a temporary file.\n * - `blob:` downloads are also captured when the platform supports them.\n * - Previewable files reopen inside the in-app browser when possible.\n * - Other files are handed off to the native preview or viewer flow.\n * - `downloadCompleted` and `downloadFailed` events notify the host app about the saved file.\n *\n * @default false\n * @since 8.6.0\n */\n handleDownloads?: boolean;\n /**\n * Share options for the webview. When provided, shows a disclaimer dialog before sharing content.\n * This is useful for:\n * - Warning users about sharing sensitive information\n * - Getting user consent before sharing\n * - Explaining what will be shared\n * - Complying with privacy regulations\n *\n * Note: shareSubject is required when using shareDisclaimer\n * @since 0.1.0\n * @example\n * shareDisclaimer: {\n * title: \"Disclaimer\",\n * message: \"This is a test disclaimer\",\n * confirmBtn: \"Accept\",\n * cancelBtn: \"Decline\"\n * }\n * Test URL: https://capgo.app\n */\n shareDisclaimer?: DisclaimerOptions;\n /**\n * Toolbar type determines the appearance and behavior of the browser's toolbar\n * - \"activity\": Shows a simple toolbar with just a close button and share button\n * - \"navigation\": Shows a full navigation toolbar with back/forward buttons\n * - \"blank\": Shows no toolbar\n * - \"\": Default toolbar with close button\n * @since 0.1.0\n * @default ToolBarType.DEFAULT\n * @example\n * toolbarType: ToolBarType.ACTIVITY,\n * title: \"Activity Toolbar Test\"\n * Test URL: https://capgo.app\n */\n toolbarType?: ToolBarType;\n /**\n * Subject text for sharing. Required when using shareDisclaimer.\n * This text will be used as the subject line when sharing content.\n * @since 0.1.0\n * @example \"Share this page\"\n */\n shareSubject?: string;\n /**\n * Title of the browser\n * @since 0.1.0\n * @default \"New Window\"\n * @example \"Camera Test\"\n */\n title?: string;\n /**\n * Native toolbar title font family.\n * On iOS, use the registered font family name. On Android, the plugin first tries a res/font resource name,\n * then falls back to a system font family name.\n *\n * @since 8.7.7\n * @example \"Inter\"\n */\n titleFontFamily?: string;\n /**\n * Native toolbar title icon displayed before the title text.\n *\n * For Android:\n * - iconType can be \"asset\" for a bundled SVG asset or \"vector\" for a drawable resource\n * - icon path should be in the public folder for assets (e.g. \"brand.svg\")\n * - width and height are optional and default to 24dp\n *\n * For iOS:\n * - iconType can be \"sf-symbol\" or \"asset\"\n * - for sf-symbol, icon should be the symbol name\n * - for asset, icon should be the asset name or bundled web asset path\n *\n * @since 8.7.7\n * @example\n * titleIcon: {\n * ios: { iconType: \"sf-symbol\", icon: \"lock.fill\" },\n * android: { iconType: \"vector\", icon: \"ic_lock\", width: 20, height: 20 }\n * }\n */\n titleIcon?: ToolbarTitleIconOptions;\n /**\n * Background color of the browser\n * @since 0.1.0\n * @default BackgroundColor.BLACK\n */\n backgroundColor?: BackgroundColor;\n /**\n * If true, enables native navigation gestures within the webview.\n * - Android: Native back button navigates within webview history\n * - iOS: Enables swipe left/right gestures for back/forward navigation\n * @default false (Android), true (iOS - enabled by default)\n * @example\n * activeNativeNavigationForWebview: true,\n * disableGoBackOnNativeApplication: true\n * Test URL: https://capgo.app\n */\n activeNativeNavigationForWebview?: boolean;\n\n /**\n * 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 *\n * On iOS, this requires overscroll bounce. If `disableOverscroll` is `true`,\n * the reload gesture will not work.\n *\n * @since 8.10.8\n * @default false\n * @example\n * enableReloadGesture: true\n */\n enableReloadGesture?: boolean;\n /**\n * Disable the possibility to go back on native application,\n * useful to force user to stay on the webview, Android only\n * @default false\n * @example\n * disableGoBackOnNativeApplication: true\n * Test URL: https://capgo.app\n */\n disableGoBackOnNativeApplication?: boolean;\n /**\n * Open url in a new window fullscreen\n * isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n * Promise timing: on Android, `openWebView()` resolves with the webview id when the webview is ready to be controlled\n * (immediately for hidden/immediate presentation, after the first page load when `isPresentAfterPageLoad` is `true`).\n * On iOS, the promise resolves with the id as soon as the native webview is created, even if presentation is deferred.\n * @since 0.1.0\n * @default false\n * @example\n * isPresentAfterPageLoad: true,\n * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n * Test URL: https://capgo.app\n */\n isPresentAfterPageLoad?: boolean;\n /**\n * Whether the website in the webview is inspectable or not, ios only\n * @default false\n */\n isInspectable?: boolean;\n /**\n * Whether the webview opening is animated or not, ios only\n * @default true\n */\n isAnimated?: boolean;\n /**\n * Shows a reload button that reloads the web page\n * @since 1.0.15\n * @default false\n * @example\n * showReloadButton: true\n * Test URL: https://capgo.app\n */\n showReloadButton?: boolean;\n /**\n * closeAction controls what happens when the native toolbar close button is pressed.\n * This does not change the behavior of close(), JavaScript window.mobileApp.close(), or native back navigation.\n *\n * @default CloseAction.CLOSE\n * @since 8.7.7\n * @example\n * closeAction: CloseAction.HIDE\n */\n closeAction?: CloseAction;\n /**\n * Captures the visible webview and includes it as `screenshot` in `hideEvent`\n * before the toolbar close button hides the webview.\n *\n * Only applies when `closeAction` is `CloseAction.HIDE`.\n *\n * On iOS, capture uses `WKWebView.takeSnapshot`. When testing through Apple's\n * iPhone Mirroring app with the physical device locked, the snapshot can succeed\n * with the correct dimensions but a fully transparent PNG. Capture works as\n * expected on a normal unlocked device. This appears to be an Apple mirroring\n * limitation rather than a plugin bug.\n *\n * @default false\n * @since 8.7.10\n */\n screenshotOnHide?: boolean;\n /**\n * CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.\n * @since 1.1.0\n * @default false\n * @example\n * closeModal: true,\n * closeModalTitle: \"Close Window\",\n * closeModalDescription: \"Are you sure you want to close?\",\n * closeModalOk: \"Yes, close\",\n * closeModalCancel: \"No, stay\"\n * Test URL: https://capgo.app\n */\n closeModal?: boolean;\n /**\n * CloseModalTitle: title of the confirm when user clicks on close button\n * @since 1.1.0\n * @default \"Close\"\n */\n closeModalTitle?: string;\n /**\n * CloseModalDescription: description of the confirm when user clicks on close button\n * @since 1.1.0\n * @default \"Are you sure you want to close this window?\"\n */\n closeModalDescription?: string;\n /**\n * CloseModalOk: text of the confirm button when user clicks on close button\n * @since 1.1.0\n * @default \"Close\"\n */\n closeModalOk?: string;\n /**\n * CloseModalCancel: text of the cancel button when user clicks on close button\n * @since 1.1.0\n * @default \"Cancel\"\n */\n closeModalCancel?: string;\n /**\n * closeModalURLPattern: a regex pattern to match against the current URL when the close button is pressed.\n * When provided along with closeModal: true, the close confirmation modal is only shown if the current URL matches this pattern.\n * If the current URL does not match, the browser closes immediately without showing the modal.\n * Requires closeModal to be true.\n * @since 7.2.0\n * @example\n * closeModal: true,\n * closeModalURLPattern: \".*checkout.*\"\n */\n closeModalURLPattern?: string;\n /**\n * visibleTitle: if true the website title would be shown else shown empty\n * @since 1.2.5\n * @default true\n */\n visibleTitle?: boolean;\n /**\n * toolbarColor: color of the toolbar in hex format\n * @since 1.2.5\n * @default \"#ffffff\"\n * @example\n * toolbarColor: \"#FF5733\"\n * Test URL: https://capgo.app\n */\n toolbarColor?: string;\n /**\n * toolbarTextColor: color of the buttons and title in the toolbar in hex format\n * When set, it overrides the automatic light/dark mode detection for text color\n * @since 6.10.0\n * @default calculated based on toolbarColor brightness\n * @example\n * toolbarTextColor: \"#FFFFFF\"\n * Test URL: https://capgo.app\n */\n toolbarTextColor?: string;\n /**\n * showArrow: if true an arrow would be shown instead of cross for closing the window\n * @since 1.2.5\n * @default false\n * @example\n * showArrow: true\n * Test URL: https://capgo.app\n */\n showArrow?: boolean;\n /**\n * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.\n * @since 6.1.0\n * @default false\n */\n ignoreUntrustedSSLError?: boolean;\n /**\n * preShowScript: if isPresentAfterPageLoad is true and this variable is set the plugin will inject a script before showing the browser.\n * This script will be run in an async context. The plugin will wait for the script to finish (max 10 seconds)\n * @since 6.6.0\n * @example\n * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n * Test URL: https://capgo.app\n */\n preShowScript?: string;\n /**\n * preShowScriptInjectionTime: controls when the preShowScript is injected.\n * - \"documentStart\": injects before any page JavaScript runs (good for polyfills like Firebase)\n * - \"pageLoad\": injects after page load (default, original behavior)\n * @since 7.26.0\n * @default \"pageLoad\"\n * @example\n * preShowScriptInjectionTime: \"documentStart\"\n */\n preShowScriptInjectionTime?: 'documentStart' | 'pageLoad';\n /**\n * Proxy interception mode.\n *\n * - `true`: legacy blanket mode, delegates all HTTP/HTTPS requests to JavaScript.\n * - `string`: Android-only regex mode kept for backward compatibility.\n *\n * Prefer `outboundProxyRules` and `inboundProxyRules` for native-first matching.\n *\n * @since 6.9.0\n */\n proxyRequests?: boolean | string;\n /**\n * Native-first outbound proxy rules.\n *\n * @since 8.6.0\n */\n outboundProxyRules?: NativeProxyRule[];\n /**\n * Native-first inbound proxy rules.\n *\n * @since 8.6.0\n */\n inboundProxyRules?: NativeProxyRule[];\n /**\n * buttonNearDone allows for a creation of a custom button near the done/close button.\n * The button is only shown when toolbarType is not \"activity\", \"navigation\", or \"blank\".\n *\n * For Android:\n * - iconType must be \"asset\"\n * - icon path should be in the public folder (e.g. \"monkey.svg\")\n * - width and height are optional, defaults to 48dp\n * - button is positioned at the end of toolbar with 8dp margin\n *\n * For iOS:\n * - iconType can be \"sf-symbol\" or \"asset\"\n * - for sf-symbol, icon should be the symbol name\n * - for asset, icon should be the asset name\n * @since 6.7.0\n * @example\n * buttonNearDone: {\n * ios: {\n * iconType: \"sf-symbol\",\n * icon: \"star.fill\"\n * },\n * android: {\n * iconType: \"asset\",\n * icon: \"public/monkey.svg\",\n * width: 24,\n * height: 24\n * }\n * }\n * Test URL: https://capgo.app\n */\n buttonNearDone?: {\n ios: {\n iconType: 'sf-symbol' | 'asset';\n icon: string;\n };\n android: {\n iconType: 'asset' | 'vector';\n icon: string;\n width?: number;\n height?: number;\n };\n };\n /**\n * Shows a native screenshot button near the done/close button.\n * The button is hidden by default and captures the current viewport when tapped.\n * This option uses the same toolbar slot as `buttonNearDone` and is therefore incompatible with it.\n * The button is only shown when toolbarType is not \"activity\", \"navigation\", or \"blank\".\n *\n * @default false\n * @since 8.4.0\n */\n showScreenshotButton?: boolean;\n /**\n * textZoom: sets the text zoom of the page in percent.\n * Allows users to increase or decrease the text size for better readability.\n * @since 7.6.0\n * @default 100\n * @example\n * textZoom: 120\n * Test URL: https://capgo.app\n */\n textZoom?: number;\n /**\n * enableZoom: enables pinch-to-zoom gestures in the Android WebView.\n * When true, built-in zoom controls are enabled and the zoom buttons are hidden.\n * **Android only** — ignored on iOS where zoom is enabled by default.\n * @since 8.5.0\n * @default false\n * @example\n * enableZoom: true\n */\n enableZoom?: boolean;\n /**\n * If true, deeplinks and external app hand-off are blocked and stay in the webview.\n * If false (default), custom schemes such as `tel:`, `mailto:`, and `sms:` open natively.\n * On iOS, listing a custom scheme under `LSApplicationQueriesSchemes` is only required when\n * you rely on `canOpenURL` for that scheme (for example `instagram://`). It is not required\n * for HTTPS `authorizedAppLinks`, and `mailto`/`tel`/`sms` open without that Info.plist entry.\n * @since 0.1.0\n * @default false\n * @example\n * preventDeeplink: true\n * Test URL: https://aasa-tester.capgo.app/\n */\n preventDeeplink?: boolean;\n\n /**\n * When true, HTTP and HTTPS links opened from `target=\"_blank\"` anchors stay in the current webview instead of spawning a popup or opening in the system browser.\n * By default, blank-target HTTP(S) links stay inside the plugin as managed popups that share cookies with the opener; enabling this option keeps everything in the same tab.\n * Custom schemes such as `tel:` and `mailto:` and authorized app links still prefer their native handlers unless `preventDeeplink` is enabled.\n *\n * @since 8.5.6\n * @default false\n * @example\n * openBlankTargetInWebView: true\n */\n openBlankTargetInWebView?: boolean;\n\n /**\n * List of base URLs whose hosts are treated as authorized App Links (Android) and Universal Links (iOS).\n *\n * - On both platforms, only HTTP(S) links whose host matches any entry in this list\n * will attempt to leave the in-app browser for the native / system handler.\n * - iOS tries a Universal Link first (`universalLinksOnly`), then falls back to a normal\n * system open (App Store, Safari, etc.). Only if both fail does the URL stay in-webview.\n * - Android uses an `ACTION_VIEW` intent for matching hosts.\n * - Matching is host-based (case-insensitive), ignoring the \"www.\" prefix.\n * - HTTPS hosts do not need `LSApplicationQueriesSchemes`; that Info.plist key is for\n * custom schemes like `instagram://`, not `https://instagram.com`.\n * - When `preventDeeplink` is enabled, all external handling is blocked regardless of this list.\n *\n * @example\n * ```ts\n * [\"https://example.com\", \"https://instagram.com\", \"https://apps.apple.com\"]\n * ```\n *\n * @since 7.12.0\n * @default []\n */\n authorizedAppLinks?: string[];\n\n /**\n * If true, the webView will not take the full height and will have a 20px margin at the bottom.\n * This creates a safe margin area outside the browser view.\n * @since 7.13.0\n * @default false\n * @example\n * enabledSafeBottomMargin: true\n */\n enabledSafeBottomMargin?: boolean;\n\n /**\n * If false, the webView will extend behind the status bar for true full-screen immersive content.\n * When true (default), respects the safe area at the top of the screen.\n * Works independently of toolbarType - use for full-screen video players, games, or immersive web apps.\n * @since 8.2.0\n * @default true\n * @example\n * enabledSafeTopMargin: false // Full screen, extends behind status bar\n */\n enabledSafeTopMargin?: boolean;\n\n /**\n * When true, applies the system status bar inset as the WebView top margin on Android.\n * Keeps the legacy 0px margin by default for apps that handle padding themselves.\n * @default false\n * @example\n * useTopInset: true\n */\n useTopInset?: boolean;\n\n /**\n * enableGooglePaySupport: if true, enables support for Google Pay popups and Payment Request API.\n * This fixes OR_BIBED_15 errors by allowing popup windows and configuring Cross-Origin-Opener-Policy.\n * Only enable this if you need Google Pay functionality as it allows popup windows.\n *\n * When enabled:\n * - Allows popup windows for Google Pay authentication\n * - Sets proper CORS headers for Payment Request API\n * - Enables multiple window support in WebView\n * - Configures secure context for payment processing\n *\n * @since 7.13.0\n * @default false\n * @example\n * enableGooglePaySupport: true\n * Test URL: https://developers.google.com/pay/api/web/guides/tutorial\n */\n enableGooglePaySupport?: boolean;\n\n /**\n * Opens popup windows created by the page in hidden mode.\n * Hidden popup windows can still be controlled with `executeScript`, `postMessage`, `show`, and `close`.\n * Listen to `popupWindowOpened` to capture the popup id, then call `show({ id })` only if you want to reveal it.\n *\n * @default false\n * @since 8.6.0\n * @example\n * hiddenPopupWindow: true\n */\n hiddenPopupWindow?: boolean;\n\n /**\n * blockedHosts: List of host patterns that should be blocked from loading in the InAppBrowser's internal navigations.\n * Any request inside WebView to a URL with a host matching any of these patterns will be blocked.\n * Supports wildcard patterns like:\n * - \"*.example.com\" to block all subdomains\n * - \"www.example.*\" to block wildcard domain extensions\n *\n * @since 7.17.0\n * @default []\n * @example\n * blockedHosts: [\"*.tracking.com\", \"ads.example.com\"]\n */\n blockedHosts?: string[];\n\n /**\n * Width of the webview in screen/window points.\n * If not set, webview will be fullscreen width.\n * @default undefined (fullscreen)\n * @example\n * width: 400\n */\n width?: number;\n\n /**\n * Height of the webview in screen/window points.\n * Required for custom-sized (non-fullscreen) webviews.\n * @default undefined (fullscreen)\n * @example\n * height: 600\n */\n height?: number;\n\n /**\n * X position of the webview in screen/window points from the left edge.\n * Only effective when custom height is set.\n * @default 0\n * @example\n * x: 50\n */\n x?: number;\n\n /**\n * Y position of the webview in screen/window points from the top edge.\n * Only effective when custom height is set.\n * @default 0\n * @example\n * y: 100\n */\n y?: number;\n\n /**\n * Places the native browser behind the Capacitor host WebView.\n * Make the app background transparent to reveal it, or rely on `transparentBackground` to clear the host WebView.\n *\n * @default false\n */\n toBack?: boolean;\n\n /**\n * When `toBack` is true, makes the Capacitor host WebView transparent so the native browser can be seen behind Ionic content.\n * Ignored when the browser is in front.\n *\n * @default true\n */\n transparentBackground?: boolean;\n\n /**\n * Disables the bounce (overscroll) effect on iOS WebView.\n * When enabled, prevents the rubber band scrolling effect when users scroll beyond content boundaries.\n * This is useful for:\n * - Creating a more native, app-like experience\n * - Preventing accidental overscroll states\n * - Avoiding issues when keyboard opens/closes\n *\n * Note: This option only affects iOS. Android does not have this bounce effect by default.\n *\n * @since 8.0.2\n * @default false\n * @example\n * disableOverscroll: true\n */\n disableOverscroll?: boolean;\n\n /**\n * Opens the webview in hidden mode (not visible to user but fully functional).\n * When hidden, the webview loads and executes JavaScript but is not displayed.\n * All control methods (executeScript, postMessage, setUrl, etc.) work while hidden.\n * Use close() to clean up the hidden webview when done.\n *\n * @since 8.0.7\n * @default false\n * @example\n * hidden: true\n */\n hidden?: boolean;\n\n /**\n * Controls how a hidden webview reports its visibility and size.\n * - AWARE: webview is aware it's hidden (dimensions may be zero).\n * - FAKE_VISIBLE: webview is hidden but reports fullscreen dimensions (uses alpha=0 to remain invisible).\n *\n * @default InvisibilityMode.AWARE\n * @example\n * invisibilityMode: InvisibilityMode.FAKE_VISIBLE\n */\n invisibilityMode?: InvisibilityMode;\n}\n\nexport interface DimensionOptions {\n /**\n * Width of the webview in pixels\n */\n width?: number;\n /**\n * Height of the webview in pixels\n */\n height?: number;\n /**\n * X position from the left edge in pixels\n */\n x?: number;\n /**\n * Y position from the top edge in pixels\n */\n y?: number;\n}\n\nexport interface InAppBrowserPlugin {\n /**\n * Navigates back in the WebView's history if possible\n *\n * @since 7.21.0\n * @returns Promise that resolves with true if navigation was possible, false otherwise\n */\n goBack(options?: { id?: string }): Promise<{ canGoBack: boolean }>;\n\n /**\n * Open url in a new window fullscreen, on android it use chrome custom tabs, on ios it use SFSafariViewController\n *\n * @since 0.1.0\n */\n open(options: OpenOptions): Promise<any>;\n\n /**\n * Clear cookies of url\n * When `id` is omitted, applies to all open webviews.\n *\n * @since 0.5.0\n */\n clearCookies(options: ClearCookieOptions): Promise<any>;\n /**\n * Clear all cookies\n * When `id` is omitted, applies to all open webviews.\n *\n * @since 6.5.0\n */\n clearAllCookies(options?: { id?: string }): Promise<any>;\n\n /**\n * Clear cache\n * When `id` is omitted, applies to all open webviews.\n *\n * @since 6.5.0\n */\n clearCache(options?: { id?: string }): Promise<any>;\n\n /**\n * Clear all browsing data from the default store and any opened managed webviews.\n *\n * This removes cookies, disk cache, memory cache, local storage, session storage, IndexedDB,\n * WebSQL where supported, form data, and HTTP auth data where the platform exposes it.\n *\n * @since 8.6.36\n */\n clearAllBrowsingData(): Promise<any>;\n\n /**\n * Get cookies for a specific URL.\n * @param options The options, including the URL to get cookies for.\n * @returns A promise that resolves with the cookies.\n */\n getCookies(options: GetCookieOptions): Promise<Record<string, string>>;\n /**\n * Close the webview.\n * When `id` is omitted, closes the active webview.\n */\n close(options?: CloseWebviewOptions): Promise<any>;\n /**\n * Hide the webview without closing it.\n * Use show() to bring it back.\n * When `id` is omitted, targets the active webview.\n *\n * @since 8.0.8\n */\n hide(options?: { id?: string }): Promise<void>;\n /**\n * Show a previously hidden webview.\n * When `id` is omitted, targets the active webview.\n *\n * @since 8.0.8\n */\n show(options?: { id?: string }): Promise<void>;\n /**\n * Moves the native browser behind the Capacitor host WebView.\n * Use `dispatchInputEvent()` to forward overlay gestures to the browser while it is behind the app UI.\n */\n sendToBack(options?: LayerOptions): Promise<void>;\n /**\n * Moves a browser that was behind the host WebView back to the front.\n * On iOS, set `isAnimated` to `false` to skip the presentation animation.\n * When `id` is omitted, targets the active webview.\n */\n bringToFront(options?: BringToFrontOptions): Promise<void>;\n /**\n * Dispatches a click, touch, or scroll event to a managed browser.\n * Coordinates are relative to the browser viewport in CSS pixels.\n */\n dispatchInputEvent(options: DispatchInputEventOptions): Promise<void>;\n /**\n * Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.\n *\n * JavaScript Interface:\n * When you open a webview with this method, a JavaScript interface is automatically injected that provides:\n * - `window.mobileApp.close()`: Closes the webview from JavaScript\n * - `window.mobileApp.postMessage({detail: {message: \"myMessage\"}})`: Sends a message from the webview to the app, detail object is the data you want to send to the webview\n * - `window.mobileApp.takeScreenshot()` when `allowScreenshotsFromWebPage` is true\n *\n * Promise timing differs by platform when `isPresentAfterPageLoad` is used.\n * Android resolves with `{ id }` after the dialog is ready to control, while iOS resolves with `{ id }` immediately after creating the native webview.\n *\n * @returns Promise that resolves with the created webview id.\n * @since 0.1.0\n */\n openWebView(options: OpenWebViewOptions): Promise<{ id: string }>;\n /**\n * Injects JavaScript code into the InAppBrowser window.\n * When `id` is omitted, executes in all open webviews.\n */\n executeScript(options: { code: string; id?: string }): Promise<void>;\n /**\n * Sends an event to the webview(inappbrowser). you can listen to this event in the inappbrowser JS with window.addEventListener(\"messageFromNative\", listenerFunc: (event: Record<string, any>) => void)\n * detail is the data you want to send to the webview, it's a requirement of Capacitor we cannot send direct objects\n * Your object has to be serializable to JSON, so no functions or other non-JSON-serializable types are allowed.\n * When `id` is omitted, broadcasts to all open webviews.\n */\n postMessage(options: { detail: Record<string, any>; id?: string }): Promise<void>;\n /**\n * Captures the current webview viewport as a PNG screenshot.\n * When `id` is omitted, targets the active webview.\n *\n * On iOS, when testing through Apple's iPhone Mirroring app with the physical\n * device locked, the snapshot can succeed with the correct dimensions but a\n * fully transparent PNG. Capture works as expected on a normal unlocked device.\n */\n takeScreenshot(options?: { id?: string }): Promise<ScreenshotResult>;\n /**\n * Sets the URL of the webview.\n * When `id` is omitted, targets the active webview.\n */\n setUrl(options: { url: string; id?: string }): Promise<any>;\n /**\n * Listen for url change, only for openWebView\n *\n * @since 0.0.1\n */\n addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener): Promise<PluginListenerHandle>;\n\n /**\n * Listen for buttonNearDone clicks.\n *\n * The event payload contains the webview `id`.\n *\n * @since 0.0.1\n */\n addListener(eventName: 'buttonNearDoneClick', listenerFunc: ButtonNearListener): Promise<PluginListenerHandle>;\n\n /**\n * Listen for close click only for openWebView\n *\n * @since 0.4.0\n */\n addListener(eventName: 'closeEvent', listenerFunc: UrlChangeListener): Promise<PluginListenerHandle>;\n /**\n * Listen for webviews hidden by the toolbar close button when closeAction is CloseAction.HIDE.\n *\n * @since 8.7.7\n */\n addListener(eventName: 'hideEvent', listenerFunc: HideListener): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when user clicks on confirm button when disclaimer is required,\n * works with openWebView shareDisclaimer and closeModal\n *\n * @since 0.0.1\n */\n addListener(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when event is sent from webview(inappbrowser), to send an event to the main app use window.mobileApp.postMessage({ \"detail\": { \"message\": \"myMessage\" } })\n * detail is the data you want to send to the main app, it's a requirement of Capacitor we cannot send direct objects\n * Your object has to be serializable to JSON, no functions or other non-JSON-serializable types are allowed.\n *\n * This method is inject at runtime in the webview\n */\n addListener(\n eventName: 'messageFromWebview',\n listenerFunc: (event: { id?: string; detail?: Record<string, any>; rawMessage?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered whenever a screenshot is captured from the plugin API,\n * the native screenshot button, or the injected JavaScript bridge.\n */\n addListener(\n eventName: 'screenshotTaken',\n listenerFunc: (event: ScreenshotResult & { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered when page is loaded\n */\n addListener(\n eventName: 'browserPageLoaded',\n listenerFunc: (event: { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered when a main-frame page load starts (link navigation, reload, etc.).\n *\n * @since 8.11.0\n */\n addListener(\n eventName: 'browserPageLoadStart',\n listenerFunc: (event: { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered as a main-frame page load progresses.\n * `progress` is a value from `0` to `1`.\n *\n * @since 8.11.0\n */\n addListener(\n eventName: 'browserPageLoadProgress',\n listenerFunc: (event: { id?: string; progress: number }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered when page load error\n */\n addListener(\n eventName: 'pageLoadError',\n listenerFunc: (event: { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when the webview intercepts a non-standard custom scheme\n * and hands it to the operating system.\n *\n * Standard OS-handled schemes such as `tel:`, `mailto:`, and `sms:` are excluded.\n *\n * @since 8.6.7\n */\n addListener(\n eventName: 'customSchemeIntercepted',\n listenerFunc: CustomSchemeInterceptedListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered after native download handling saves a file locally.\n * Enable this with `handleDownloads: true` when opening the webview.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'downloadCompleted',\n listenerFunc: (event: DownloadCompletedEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when native download handling fails.\n * Enable this with `handleDownloads: true` when opening the webview.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'downloadFailed',\n listenerFunc: (event: DownloadFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered whenever a page opens a popup/new window.\n * Use the returned popup id with `executeScript`, `postMessage`, `show`, `hide`, and `close`.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'popupWindowOpened',\n listenerFunc: (event: PopupWindowEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for proxied requests delegated by the native runtime.\n * Prefer `addProxyHandler()` instead of calling this directly.\n *\n * @since 8.6.0\n */\n addListener(eventName: 'proxyRequest', listenerFunc: (event: ProxyRequest) => void): Promise<PluginListenerHandle>;\n /**\n * Listen for JavaScript console output emitted by the managed page.\n * Enable this with `captureConsoleLogs: true` when opening the webview.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'consoleMessage',\n listenerFunc: (event: ConsoleMessageEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Internal method used by `addProxyHandler()` to send a proxy decision back to native.\n * Forward the original `phase` when replying to a manual `proxyRequest` listener.\n *\n * @since 8.6.0\n */\n handleProxyRequest(options: {\n requestId: string;\n decision?: ProxyDecision | null;\n response?: ProxyResponse | null;\n webviewId?: string;\n phase?: 'outbound' | 'inbound';\n }): Promise<void>;\n /**\n * Remove all listeners for this plugin.\n *\n * @since 1.0.0\n */\n removeAllListeners(): Promise<void>;\n\n /**\n * Reload the current web page.\n *\n * @since 1.0.0\n */\n reload(options?: { id?: string }): Promise<any>;\n\n /**\n * Update the dimensions of the webview.\n * Allows changing the size and position of the webview at runtime.\n * When `id` is omitted, targets the active webview.\n *\n * @param options Dimension options (width, height, x, y)\n * @returns Promise that resolves when dimensions are updated\n */\n updateDimensions(options: DimensionOptions & { id?: string }): Promise<void>;\n\n /**\n * Sets the enabled safe top margin of the webview at runtime.\n * When `id` is omitted, targets the active webview.\n * On Web, this method is a no-op and resolves without changing layout.\n */\n setEnabledSafeTopMargin(options: { enabled: boolean; id?: string }): Promise<void>;\n\n /**\n * Sets the enabled safe bottom margin of the webview at runtime.\n * When `id` is omitted, targets the active webview.\n * On Web, this method is a no-op and resolves without changing layout.\n */\n setEnabledSafeBottomMargin(options: { enabled: boolean; id?: string }): Promise<void>;\n\n /**\n * Opens a secured window for OAuth2 authentication.\n *\n * On web, the redirect page should post the final URL to a `BroadcastChannel` and close itself.\n * On mobile, register a custom redirect URI scheme (for example `myapp://oauth_callback/`) in Info.plist and AndroidManifest.xml.\n * See the README section \"openSecureWindow (OAuth)\" for full setup examples.\n *\n * @param options - the options for the openSecureWindow call\n */\n openSecureWindow(options: OpenSecureWindowOptions): Promise<OpenSecureWindowResponse>;\n}\n\n/**\n * JavaScript APIs available in the InAppBrowser WebView.\n *\n * These APIs are automatically injected into all webpages loaded in the InAppBrowser WebView.\n *\n * @example\n * // Closing the webview from JavaScript\n * window.mobileApp.close();\n *\n * // Sending a message from webview to the native app\n * window.mobileApp.postMessage({ key: \"value\" });\n *\n * @since 6.10.0\n */\nexport interface InAppBrowserWebViewAPIs {\n /**\n * mobileApp - Global object injected into the WebView providing communication with the native app\n */\n mobileApp: {\n /**\n * Close the WebView from JavaScript\n *\n * @example\n * // Add a button to close the webview\n * const closeButton = document.createElement(\"button\");\n * closeButton.textContent = \"Close WebView\";\n * closeButton.addEventListener(\"click\", () => {\n * window.mobileApp.close();\n * });\n * document.body.appendChild(closeButton);\n *\n * @since 6.10.0\n */\n close(): void;\n\n /**\n * Send a message from the WebView to the native app\n * The native app can listen for these messages with the \"messageFromWebview\" event\n *\n * @param message Object to send to the native app\n * @example\n * // Send data to native app\n * window.mobileApp.postMessage({\n * action: \"dataSubmitted\",\n * data: { username: \"test\", email: \"test@example.com\" }\n * });\n *\n * @since 6.10.0\n */\n postMessage(message: Record<string, any>): void;\n\n /**\n * Hide the WebView from JavaScript (requires allowWebViewJsVisibilityControl: true in CapacitorConfig)\n *\n * @since 8.0.8\n */\n hide(): void;\n\n /**\n * Show the WebView from JavaScript (requires allowWebViewJsVisibilityControl: true in CapacitorConfig)\n *\n * @since 8.0.8\n */\n show(): void;\n\n /**\n * Capture the current WebView viewport as a PNG screenshot.\n * Requires `allowScreenshotsFromWebPage` to be enabled when opening the webview.\n *\n * @since 8.4.0\n */\n takeScreenshot(): Promise<ScreenshotResult>;\n };\n\n /**\n * Get the native Capacitor plugin version\n *\n * @returns {Promise<{ id: string }>} an Promise with version for this device\n * @throws An error if the something went wrong\n */\n getPluginVersion(): Promise<{ version: string }>;\n}\n"]}
1
+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAmEA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AACD,MAAM,CAAN,IAAY,WAqBX;AArBD,WAAY,WAAW;IACrB;;;OAGG;IACH,oCAAqB,CAAA;IACrB;;;OAGG;IACH,kCAAmB,CAAA;IACnB;;;OAGG;IACH,wCAAyB,CAAA;IACzB;;;OAGG;IACH,8BAAe,CAAA;AACjB,CAAC,EArBW,WAAW,KAAX,WAAW,QAqBtB;AAED,MAAM,CAAN,IAAY,gBASX;AATD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,mCAAe,CAAA;IACf;;OAEG;IACH,iDAA6B,CAAA;AAC/B,CAAC,EATW,gBAAgB,KAAhB,gBAAgB,QAS3B;AAED,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB;;OAEG;IACH,8BAAe,CAAA;IACf;;OAEG;IACH,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,KAAX,WAAW,QAStB","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface UrlEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * Emit when the url changes\n *\n * @since 0.0.1\n */\n url: string;\n}\n\n/**\n * Event emitted when the managed webview intercepts a non-standard custom scheme\n * and hands it to the operating system.\n *\n * Standard OS-handled schemes such as `tel:`, `mailto:`, and `sms:` are excluded.\n *\n * @since 8.6.7\n */\nexport interface CustomSchemeInterceptedEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * Intercepted URL.\n */\n url: string;\n /**\n * Whether the operating system accepted the URL handoff.\n */\n opened: boolean;\n}\nexport interface BtnEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * Emit when a button is clicked.\n *\n * @since 0.0.1\n */\n url: string;\n}\n\nexport interface ButtonNearDoneEvent {\n /**\n * Webview instance id.\n *\n * @since 8.6.36\n */\n id: string;\n}\n\nexport type UrlChangeListener = (state: UrlEvent) => void;\nexport type ConfirmBtnListener = (state: BtnEvent) => void;\nexport type ButtonNearListener = (state: ButtonNearDoneEvent) => void;\nexport type CustomSchemeInterceptedListener = (state: CustomSchemeInterceptedEvent) => void;\n\nexport type WebViewPointerInputEventType = 'click' | 'touchstart' | 'touchmove' | 'touchend' | 'touchcancel';\nexport type WebViewInputEventType = WebViewPointerInputEventType | 'scroll';\n\nexport enum BackgroundColor {\n WHITE = 'white',\n BLACK = 'black',\n}\nexport enum ToolBarType {\n /**\n * Shows a simple toolbar with just a close button and share button\n * @since 0.1.0\n */\n ACTIVITY = 'activity',\n /**\n * Shows a simple toolbar with just a close button\n * @since 7.6.8\n */\n COMPACT = 'compact',\n /**\n * Shows a full navigation toolbar with back/forward buttons\n * @since 0.1.0\n */\n NAVIGATION = 'navigation',\n /**\n * Shows no toolbar\n * @since 0.1.0\n */\n BLANK = 'blank',\n}\n\nexport enum InvisibilityMode {\n /**\n * WebView is aware it is hidden (dimensions may be zero).\n */\n AWARE = 'AWARE',\n /**\n * WebView is hidden but reports fullscreen dimensions (uses alpha=0 to remain invisible).\n */\n FAKE_VISIBLE = 'FAKE_VISIBLE',\n}\n\nexport enum CloseAction {\n /**\n * The toolbar close button closes and destroys the webview.\n */\n CLOSE = 'close',\n /**\n * The toolbar close button hides the webview so it can be shown again.\n */\n HIDE = 'hide',\n}\n\nexport interface ToolbarTitleIconOptions {\n ios?: {\n iconType: 'sf-symbol' | 'asset';\n icon: string;\n };\n android?: {\n iconType: 'asset' | 'vector';\n icon: string;\n width?: number;\n height?: number;\n };\n}\n\nexport interface Headers {\n [key: string]: string;\n}\n\nexport interface GetCookieOptions {\n url: string;\n includeHttpOnly?: boolean;\n}\n\nexport interface ClearCookieOptions {\n /**\n * Target webview id.\n * When omitted, applies to all open webviews.\n */\n id?: string;\n url: string;\n}\n\nexport interface Credentials {\n username: string;\n password: string;\n}\n\nexport interface LayerOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Makes the Capacitor host WebView transparent while this native webview is behind it.\n *\n * @default true\n */\n transparentBackground?: boolean;\n}\n\nexport interface BringToFrontOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Whether bringing the webview to the front is animated on iOS.\n *\n * @default true\n */\n isAnimated?: boolean;\n}\n\nexport interface DispatchPointerInputEventOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Input event to dispatch to the webview.\n */\n type: WebViewPointerInputEventType;\n /**\n * X coordinate in CSS pixels from the webview's left edge.\n */\n x: number;\n /**\n * Y coordinate in CSS pixels from the webview's top edge.\n */\n y: number;\n}\n\nexport interface DispatchScrollInputEventOptions {\n /**\n * Target webview id. If omitted, targets the active webview.\n */\n id?: string;\n /**\n * Input event to dispatch to the webview.\n */\n type: 'scroll';\n /**\n * X coordinate in CSS pixels from the webview's left edge.\n */\n x: number;\n /**\n * Y coordinate in CSS pixels from the webview's top edge.\n */\n y: number;\n /**\n * Horizontal scroll delta in CSS pixels. Used when `type` is `scroll`.\n */\n deltaX: number;\n /**\n * Vertical scroll delta in CSS pixels. Used when `type` is `scroll`.\n */\n deltaY: number;\n}\n\nexport type DispatchInputEventOptions = DispatchPointerInputEventOptions | DispatchScrollInputEventOptions;\n\n/**\n * Represents an intercepted HTTP request from the in-app browser webview.\n *\n * Request and response bodies are base64-encoded when present.\n *\n * @since 8.6.0\n */\nexport interface ProxyRequest {\n requestId: string;\n phase: 'outbound' | 'inbound';\n url: string;\n method: string;\n headers: Record<string, string>;\n body: string | null;\n status?: number;\n responseHeaders?: Record<string, string>;\n responseBody?: string | null;\n webviewId: string;\n}\n\n/**\n * Response payload returned to native for a proxied request.\n *\n * The body must be base64-encoded.\n *\n * @since 8.6.0\n */\nexport interface ProxyResponse {\n body: string;\n status: number;\n headers: Record<string, string>;\n}\n\n/**\n * Request override returned to native for an outbound proxied request.\n *\n * The body must be base64-encoded when present.\n *\n * @since 8.6.0\n */\nexport interface ProxyRequestOverride {\n url: string;\n method?: string;\n headers?: Record<string, string>;\n body?: string | null;\n}\n\n/**\n * Event emitted when a web page opens a popup/new window.\n *\n * @since 8.6.0\n */\nexport interface PopupWindowEvent {\n /**\n * Popup webview instance id.\n */\n id: string;\n /**\n * Parent webview instance id.\n */\n parentId?: string;\n /**\n * Requested popup URL when available.\n */\n url?: string;\n /**\n * Whether the popup was presented immediately.\n */\n visible: boolean;\n}\n\n/**\n * Event emitted when JavaScript running inside the managed webview writes to the console.\n *\n * Enable this with `captureConsoleLogs: true` when opening the webview.\n *\n * @since 8.6.0\n */\nexport interface ConsoleMessageEvent {\n /**\n * Source webview instance id.\n */\n id?: string;\n /**\n * Console method or normalized severity.\n */\n level: 'log' | 'info' | 'warn' | 'error' | 'debug' | 'assert' | string;\n /**\n * Joined string representation of the console arguments.\n */\n message: string;\n /**\n * Script URL or page URL when available.\n */\n source?: string;\n /**\n * 1-based line number when available.\n */\n line?: number;\n /**\n * 1-based column number when available.\n */\n column?: number;\n /**\n * Optional subtype for runtime-originated errors on supported platforms.\n */\n kind?: string;\n}\n\n/**\n * Native handling mode used after a managed download finishes.\n *\n * @since 8.6.0\n */\nexport type DownloadHandledBy = 'inAppBrowser' | 'systemPreview' | 'external';\n\n/**\n * Event emitted after a managed download is saved locally.\n *\n * @since 8.6.0\n */\nexport interface DownloadCompletedEvent {\n /**\n * Source webview instance id.\n */\n id?: string;\n /**\n * Original URL that triggered the download when available.\n */\n sourceUrl?: string;\n /**\n * Saved filename.\n */\n fileName: string;\n /**\n * Resolved MIME type when available.\n */\n mimeType?: string;\n /**\n * Absolute native filesystem path to the saved file.\n */\n path: string;\n /**\n * `file://` URL pointing at the saved file.\n */\n localUrl: string;\n /**\n * How native handled the downloaded file after saving it.\n */\n handledBy: DownloadHandledBy;\n}\n\n/**\n * Event emitted when managed download handling fails.\n *\n * @since 8.6.0\n */\nexport interface DownloadFailedEvent {\n /**\n * Source webview instance id.\n */\n id?: string;\n /**\n * Original URL that triggered the download when available.\n */\n sourceUrl?: string;\n /**\n * Intended filename when known.\n */\n fileName?: string;\n /**\n * Resolved MIME type when available.\n */\n mimeType?: string;\n /**\n * Native error message.\n */\n error: string;\n}\n\n/**\n * Decision returned to native when handling a proxied request.\n *\n * @since 8.6.0\n */\nexport interface ProxyDecision {\n request?: ProxyRequestOverride | null;\n response?: ProxyResponse | null;\n cancel?: boolean;\n}\n\n/**\n * Native-first proxy rule used on Android and iOS.\n *\n * Any regex property that is omitted is treated as a wildcard.\n *\n * @since 8.6.0\n */\nexport interface NativeProxyRule {\n id?: string;\n urlRegex?: string;\n methodRegex?: string;\n headerRegex?: string;\n bodyRegex?: string;\n statusRegex?: string;\n responseHeaderRegex?: string;\n responseBodyRegex?: string;\n mainFrameOnly?: boolean;\n action: 'continue' | 'cancel' | 'delegateToJs';\n}\n\nexport type ProxyHandlerResult = Response | ProxyResponse | ProxyRequestOverride | ProxyDecision | null;\n\n/**\n * JavaScript callback used to handle proxied requests.\n *\n * Return a `Response`, `ProxyResponse`, `ProxyRequestOverride`, `ProxyDecision`,\n * or `null` to let native continue unchanged.\n *\n * @since 8.6.0\n */\nexport type ProxyHandler = (request: ProxyRequest) => ProxyHandlerResult | Promise<ProxyHandlerResult>;\n\nexport interface OpenOptions {\n /**\n * Target URL to load.\n * @since 0.1.0\n */\n url: string;\n /**\n * if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n * @since 0.1.0\n */\n isPresentAfterPageLoad?: boolean;\n /**\n * if true the deeplink will not be opened, if false the deeplink will be opened when clicked on the link\n * @since 0.1.0\n */\n preventDeeplink?: boolean;\n\n // --- Chrome Custom Tab customization (Android only, ignored on iOS) ---\n\n /**\n * Toolbar background color in hex format (e.g., \"#1A1A2E\").\n * Applied to both light and dark color schemes.\n * Also sets the navigation bar color to match.\n * **Android only** — ignored on iOS.\n * @since 8.2.0\n */\n toolbarColor?: string;\n\n /**\n * Whether the URL bar should auto-hide when the user scrolls down.\n * The bar reappears on any upward scroll.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n urlBarHidingEnabled?: boolean;\n\n /**\n * Show the page's HTML <title> in the toolbar instead of the raw URL.\n * The true URL is still visible when the user taps the title area.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n showTitle?: boolean;\n\n /**\n * Replace the default \"X\" close icon with a back arrow.\n * Makes the Custom Tab feel like a native navigation push rather than a modal overlay.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n showArrow?: boolean;\n\n /**\n * Remove the share action from the overflow menu.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n disableShare?: boolean;\n\n /**\n * Hide the bookmark star icon in the overflow menu.\n * Uses an undocumented Chromium intent extra — may stop working on future Chrome updates.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n disableBookmark?: boolean;\n\n /**\n * Hide the download icon in the overflow menu.\n * Uses an undocumented Chromium intent extra — may stop working on future Chrome updates.\n * **Android only** — ignored on iOS.\n * @default false\n * @since 8.2.0\n */\n disableDownload?: boolean;\n}\n\nexport interface OpenSecureWindowOptions {\n /**\n * The endpoint to open\n */\n authEndpoint: string;\n /**\n * The redirect URI to use for the openSecureWindow call.\n * This will be checked to make sure it matches the redirect URI after the window finishes the redirection.\n */\n redirectUri: string;\n /**\n * The name of the broadcast channel to listen to, relevant only for web\n */\n broadcastChannelName?: string;\n /**\n * If true, the browser session will be ephemeral (no cookies or browsing data are shared with the system browser).\n * On iOS, this sets `prefersEphemeralWebBrowserSession = true` on `ASWebAuthenticationSession`.\n * On Android, this enables Custom Tabs ephemeral browsing via `setEphemeralBrowsingEnabled(true)`.\n * @default false\n * @since 6.6.0\n */\n prefersEphemeralWebBrowserSession?: boolean;\n}\n\nexport interface OpenSecureWindowResponse {\n /**\n * The result of the openSecureWindow call\n */\n redirectedUri: string;\n}\n\nexport interface DisclaimerOptions {\n /**\n * Title of the disclaimer dialog\n * @default \"Title\"\n */\n title: string;\n /**\n * Message shown in the disclaimer dialog\n * @default \"Message\"\n */\n message: string;\n /**\n * Text for the confirm button\n * @default \"Confirm\"\n */\n confirmBtn: string;\n /**\n * Text for the cancel button\n * @default \"Cancel\"\n */\n cancelBtn: string;\n}\n\nexport interface ScreenshotResult {\n /**\n * Image format used for the screenshot.\n */\n format: 'png';\n /**\n * MIME type of the generated screenshot.\n */\n mimeType: 'image/png';\n /**\n * Base64-encoded screenshot payload without the data URL prefix.\n */\n base64: string;\n /**\n * Data URL for direct use in HTML img tags or uploads.\n */\n dataUrl: string;\n /**\n * Screenshot width in pixels.\n */\n width: number;\n /**\n * Screenshot height in pixels.\n */\n height: number;\n}\n\nexport interface HideEvent {\n /**\n * Webview instance id.\n */\n id?: string;\n /**\n * URL active when the webview was hidden.\n */\n url: string;\n /**\n * Screenshot captured immediately before the toolbar close button hides the webview.\n * Present only when `screenshotOnHide` is enabled and capture succeeds.\n */\n screenshot?: ScreenshotResult;\n}\n\nexport type HideListener = (state: HideEvent) => void;\n\nexport interface CloseWebviewOptions {\n /**\n * Target webview id to close. If omitted, closes the active webview.\n */\n id?: string;\n /**\n * Whether the webview closing is animated or not, ios only\n * @default true\n */\n isAnimated?: boolean;\n}\n\nexport interface OpenWebViewOptions {\n /**\n * Target URL to load.\n * @since 0.1.0\n * @example \"https://capgo.app\"\n */\n url: string;\n /**\n * Headers to send with the request.\n * @since 0.1.0\n * @example\n * headers: {\n * \"Custom-Header\": \"test-value\",\n * \"Authorization\": \"Bearer test-token\"\n * }\n * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n */\n headers?: Headers;\n /**\n * Custom User-Agent string for the webview.\n *\n * When set, replaces the system default webview User-Agent on iOS and Android.\n * Takes precedence over a `User-Agent` entry in `headers`.\n *\n * @since 8.13.0\n * @example\n * customUserAgent: \"MyApp/1.0 (Capacitor)\"\n * Test URL: https://www.whatismybrowser.com/detect/what-is-my-user-agent/\n */\n customUserAgent?: string;\n /**\n * Credentials to send with the request and all subsequent requests for the same host.\n * @since 6.1.0\n * @example\n * credentials: {\n * username: \"test-user\",\n * password: \"test-pass\"\n * }\n * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n */\n credentials?: Credentials;\n /**\n * HTTP method to use for the initial request.\n *\n * **Optional parameter - defaults to GET if not specified.**\n * Existing code that doesn't provide this parameter will continue to work unchanged with standard GET requests.\n *\n * When specified with 'POST', 'PUT', or 'PATCH' methods that support a body,\n * you can also provide a `body` parameter with the request payload.\n *\n * **Platform Notes:**\n * - iOS: Full support for all HTTP methods with headers\n * - Android: Custom headers may not be sent with POST/PUT/PATCH requests due to WebView limitations\n *\n * @since 8.2.0\n * @default \"GET\"\n * @example\n * method: \"POST\",\n * body: JSON.stringify({ token: \"auth-token\", data: \"value\" }),\n * headers: { \"Content-Type\": \"application/json\" }\n */\n method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | string;\n /**\n * HTTP body to send with the request when using POST, PUT, or other methods that support a body.\n * Should be a string (use JSON.stringify for JSON data).\n *\n * **Optional parameter - only used when `method` is specified and supports a request body.**\n * Omitting this parameter (or using GET method) results in standard behavior without a request body.\n *\n * @since 8.2.0\n * @example\n * method: \"POST\",\n * body: JSON.stringify({ username: \"user\", password: \"pass\" }),\n * headers: { \"Content-Type\": \"application/json\" }\n */\n body?: string;\n /**\n * materialPicker: if true, uses Material Design theme for date and time pickers on Android.\n * This improves the appearance of HTML date inputs to use modern Material Design UI instead of the old style pickers.\n * @since 7.4.1\n * @default false\n * @example\n * materialPicker: true\n * Test URL: https://show-picker.glitch.me/demo.html\n */\n materialPicker?: boolean;\n /**\n * JavaScript Interface:\n * The webview automatically injects a JavaScript interface providing:\n * - `window.mobileApp.close()`: Closes the webview from JavaScript\n * - `window.mobileApp.postMessage(obj)`: Sends a message to the app (listen via \"messageFromWebview\" event)\n * - `window.mobileApp.hide()` / `window.mobileApp.show()` when allowWebViewJsVisibilityControl is true in CapacitorConfig\n * - `window.mobileApp.takeScreenshot()` when `allowScreenshotsFromWebPage` is true\n *\n * @example\n * // In your webpage loaded in the webview:\n * document.getElementById(\"closeBtn\").addEventListener(\"click\", () => {\n * window.mobileApp.close();\n * });\n *\n * // Send data to the app\n * window.mobileApp.postMessage({ action: \"login\", data: { user: \"test\" }});\n *\n * @since 6.10.0\n */\n jsInterface?: never; // This property doesn't exist, it's just for documentation\n /**\n * Allows page JavaScript to call `window.mobileApp.takeScreenshot()`.\n * Disabled by default so only the host app can trigger native screenshots through the plugin API.\n *\n * @default false\n * @since 8.4.0\n */\n allowScreenshotsFromWebPage?: boolean;\n /**\n * Emits `consoleMessage` events for JavaScript `console.*` output coming from the managed page.\n * Useful when the webview stays hidden and you still need page-level diagnostics.\n *\n * @default false\n * @since 8.6.0\n */\n captureConsoleLogs?: boolean;\n /**\n * Controls whether the webview should persist website data such as cache, cookies, local storage,\n * IndexedDB, and session data.\n *\n * When false, iOS uses a non-persistent `WKWebsiteDataStore`. Android disables per-view cache and\n * DOM/database storage where the system WebView supports it. Android cookies use the shared\n * WebView cookie store, so call `clearAllBrowsingData()` to remove cookies and other global data.\n *\n * @default true\n * @since 8.6.36\n */\n persistWebViewData?: boolean;\n /**\n * Controls Android TLS client certificate prompts during HTTPS handshakes.\n * Use `prompt` to show the system certificate picker; omit or use `none` to cancel silently (default).\n *\n * @default \"none\"\n * @since 8.7.5\n */\n clientCertificate?: 'none' | 'prompt';\n /**\n * @deprecated Use `clientCertificate: \"prompt\"` instead.\n */\n clientCertificatePrompt?: boolean;\n /**\n * Automatically handles downloads triggered inside the webview without requiring a custom JavaScript bridge.\n *\n * When enabled:\n * - Standard attachment responses are written to a temporary file.\n * - `blob:` downloads are also captured when the platform supports them.\n * - Previewable files reopen inside the in-app browser when possible.\n * - Other files are handed off to the native preview or viewer flow.\n * - `downloadCompleted` and `downloadFailed` events notify the host app about the saved file.\n *\n * @default false\n * @since 8.6.0\n */\n handleDownloads?: boolean;\n /**\n * Share options for the webview. When provided, shows a disclaimer dialog before sharing content.\n * This is useful for:\n * - Warning users about sharing sensitive information\n * - Getting user consent before sharing\n * - Explaining what will be shared\n * - Complying with privacy regulations\n *\n * Note: shareSubject is required when using shareDisclaimer\n * @since 0.1.0\n * @example\n * shareDisclaimer: {\n * title: \"Disclaimer\",\n * message: \"This is a test disclaimer\",\n * confirmBtn: \"Accept\",\n * cancelBtn: \"Decline\"\n * }\n * Test URL: https://capgo.app\n */\n shareDisclaimer?: DisclaimerOptions;\n /**\n * Toolbar type determines the appearance and behavior of the browser's toolbar\n * - \"activity\": Shows a simple toolbar with just a close button and share button\n * - \"navigation\": Shows a full navigation toolbar with back/forward buttons\n * - \"blank\": Shows no toolbar\n * - \"\": Default toolbar with close button\n * @since 0.1.0\n * @default ToolBarType.DEFAULT\n * @example\n * toolbarType: ToolBarType.ACTIVITY,\n * title: \"Activity Toolbar Test\"\n * Test URL: https://capgo.app\n */\n toolbarType?: ToolBarType;\n /**\n * Subject text for sharing. Required when using shareDisclaimer.\n * This text will be used as the subject line when sharing content.\n * @since 0.1.0\n * @example \"Share this page\"\n */\n shareSubject?: string;\n /**\n * Title of the browser\n * @since 0.1.0\n * @default \"New Window\"\n * @example \"Camera Test\"\n */\n title?: string;\n /**\n * Native toolbar title font family.\n * On iOS, use the registered font family name. On Android, the plugin first tries a res/font resource name,\n * then falls back to a system font family name.\n *\n * @since 8.7.7\n * @example \"Inter\"\n */\n titleFontFamily?: string;\n /**\n * Native toolbar title icon displayed before the title text.\n *\n * For Android:\n * - iconType can be \"asset\" for a bundled SVG asset or \"vector\" for a drawable resource\n * - icon path should be in the public folder for assets (e.g. \"brand.svg\")\n * - width and height are optional and default to 24dp\n *\n * For iOS:\n * - iconType can be \"sf-symbol\" or \"asset\"\n * - for sf-symbol, icon should be the symbol name\n * - for asset, icon should be the asset name or bundled web asset path\n *\n * @since 8.7.7\n * @example\n * titleIcon: {\n * ios: { iconType: \"sf-symbol\", icon: \"lock.fill\" },\n * android: { iconType: \"vector\", icon: \"ic_lock\", width: 20, height: 20 }\n * }\n */\n titleIcon?: ToolbarTitleIconOptions;\n /**\n * Background color of the browser\n * @since 0.1.0\n * @default BackgroundColor.BLACK\n */\n backgroundColor?: BackgroundColor;\n /**\n * If true, enables native navigation gestures within the webview.\n * - Android: Native back button navigates within webview history\n * - iOS: Enables swipe left/right gestures for back/forward navigation\n * @default false (Android), true (iOS - enabled by default)\n * @example\n * activeNativeNavigationForWebview: true,\n * disableGoBackOnNativeApplication: true\n * Test URL: https://capgo.app\n */\n activeNativeNavigationForWebview?: boolean;\n\n /**\n * Enable pull-to-refresh (overscroll from top) to reload the current page.\n * - iOS: Uses UIRefreshControl on the WebView scroll view (reload commits on finger release)\n * - Android: Uses SwipeRefreshLayout around the WebView\n *\n * On iOS, this requires overscroll bounce. If `disableOverscroll` is `true`,\n * the reload gesture will not work.\n *\n * @since 8.10.8\n * @default false\n * @example\n * enableReloadGesture: true\n */\n enableReloadGesture?: boolean;\n /**\n * Disable the possibility to go back on native application,\n * useful to force user to stay on the webview, Android only\n * @default false\n * @example\n * disableGoBackOnNativeApplication: true\n * Test URL: https://capgo.app\n */\n disableGoBackOnNativeApplication?: boolean;\n /**\n * Open url in a new window fullscreen\n * isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n * Promise timing: on Android, `openWebView()` resolves with the webview id when the webview is ready to be controlled\n * (immediately for hidden/immediate presentation, after the first page load when `isPresentAfterPageLoad` is `true`).\n * On iOS, the promise resolves with the id as soon as the native webview is created, even if presentation is deferred.\n * @since 0.1.0\n * @default false\n * @example\n * isPresentAfterPageLoad: true,\n * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n * Test URL: https://capgo.app\n */\n isPresentAfterPageLoad?: boolean;\n /**\n * Whether the website in the webview is inspectable or not, ios only\n * @default false\n */\n isInspectable?: boolean;\n /**\n * Whether the webview opening is animated or not, ios only\n * @default true\n */\n isAnimated?: boolean;\n /**\n * Shows a reload button that reloads the web page\n * @since 1.0.15\n * @default false\n * @example\n * showReloadButton: true\n * Test URL: https://capgo.app\n */\n showReloadButton?: boolean;\n /**\n * closeAction controls what happens when the native toolbar close button is pressed.\n * This does not change the behavior of close(), JavaScript window.mobileApp.close(), or native back navigation.\n *\n * @default CloseAction.CLOSE\n * @since 8.7.7\n * @example\n * closeAction: CloseAction.HIDE\n */\n closeAction?: CloseAction;\n /**\n * Captures the visible webview and includes it as `screenshot` in `hideEvent`\n * before the toolbar close button hides the webview.\n *\n * Only applies when `closeAction` is `CloseAction.HIDE`.\n *\n * On iOS, capture uses `WKWebView.takeSnapshot`. When testing through Apple's\n * iPhone Mirroring app with the physical device locked, the snapshot can succeed\n * with the correct dimensions but a fully transparent PNG. Capture works as\n * expected on a normal unlocked device. This appears to be an Apple mirroring\n * limitation rather than a plugin bug.\n *\n * @default false\n * @since 8.7.10\n */\n screenshotOnHide?: boolean;\n /**\n * CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.\n * @since 1.1.0\n * @default false\n * @example\n * closeModal: true,\n * closeModalTitle: \"Close Window\",\n * closeModalDescription: \"Are you sure you want to close?\",\n * closeModalOk: \"Yes, close\",\n * closeModalCancel: \"No, stay\"\n * Test URL: https://capgo.app\n */\n closeModal?: boolean;\n /**\n * CloseModalTitle: title of the confirm when user clicks on close button\n * @since 1.1.0\n * @default \"Close\"\n */\n closeModalTitle?: string;\n /**\n * CloseModalDescription: description of the confirm when user clicks on close button\n * @since 1.1.0\n * @default \"Are you sure you want to close this window?\"\n */\n closeModalDescription?: string;\n /**\n * CloseModalOk: text of the confirm button when user clicks on close button\n * @since 1.1.0\n * @default \"Close\"\n */\n closeModalOk?: string;\n /**\n * CloseModalCancel: text of the cancel button when user clicks on close button\n * @since 1.1.0\n * @default \"Cancel\"\n */\n closeModalCancel?: string;\n /**\n * closeModalURLPattern: a regex pattern to match against the current URL when the close button is pressed.\n * When provided along with closeModal: true, the close confirmation modal is only shown if the current URL matches this pattern.\n * If the current URL does not match, the browser closes immediately without showing the modal.\n * Requires closeModal to be true.\n * @since 7.2.0\n * @example\n * closeModal: true,\n * closeModalURLPattern: \".*checkout.*\"\n */\n closeModalURLPattern?: string;\n /**\n * visibleTitle: if true the website title would be shown else shown empty\n * @since 1.2.5\n * @default true\n */\n visibleTitle?: boolean;\n /**\n * toolbarColor: color of the toolbar in hex format\n * @since 1.2.5\n * @default \"#ffffff\"\n * @example\n * toolbarColor: \"#FF5733\"\n * Test URL: https://capgo.app\n */\n toolbarColor?: string;\n /**\n * toolbarTextColor: color of the buttons and title in the toolbar in hex format\n * When set, it overrides the automatic light/dark mode detection for text color\n * @since 6.10.0\n * @default calculated based on toolbarColor brightness\n * @example\n * toolbarTextColor: \"#FFFFFF\"\n * Test URL: https://capgo.app\n */\n toolbarTextColor?: string;\n /**\n * showArrow: if true an arrow would be shown instead of cross for closing the window\n * @since 1.2.5\n * @default false\n * @example\n * showArrow: true\n * Test URL: https://capgo.app\n */\n showArrow?: boolean;\n /**\n * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.\n * @since 6.1.0\n * @default false\n */\n ignoreUntrustedSSLError?: boolean;\n /**\n * preShowScript: if isPresentAfterPageLoad is true and this variable is set the plugin will inject a script before showing the browser.\n * This script will be run in an async context. The plugin will wait for the script to finish (max 10 seconds)\n * @since 6.6.0\n * @example\n * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n * Test URL: https://capgo.app\n */\n preShowScript?: string;\n /**\n * preShowScriptInjectionTime: controls when the preShowScript is injected.\n * - \"documentStart\": injects before any page JavaScript runs (good for polyfills like Firebase)\n * - \"pageLoad\": injects after page load (default, original behavior)\n * @since 7.26.0\n * @default \"pageLoad\"\n * @example\n * preShowScriptInjectionTime: \"documentStart\"\n */\n preShowScriptInjectionTime?: 'documentStart' | 'pageLoad';\n /**\n * Proxy interception mode.\n *\n * - `true`: legacy blanket mode, delegates all HTTP/HTTPS requests to JavaScript.\n * - `string`: Android-only regex mode kept for backward compatibility.\n *\n * Prefer `outboundProxyRules` and `inboundProxyRules` for native-first matching.\n *\n * @since 6.9.0\n */\n proxyRequests?: boolean | string;\n /**\n * Native-first outbound proxy rules.\n *\n * @since 8.6.0\n */\n outboundProxyRules?: NativeProxyRule[];\n /**\n * Native-first inbound proxy rules.\n *\n * @since 8.6.0\n */\n inboundProxyRules?: NativeProxyRule[];\n /**\n * buttonNearDone allows for a creation of a custom button near the done/close button.\n * The button is only shown when toolbarType is not \"activity\", \"navigation\", or \"blank\".\n *\n * For Android:\n * - iconType must be \"asset\"\n * - icon path should be in the public folder (e.g. \"monkey.svg\")\n * - width and height are optional, defaults to 48dp\n * - button is positioned at the end of toolbar with 8dp margin\n *\n * For iOS:\n * - iconType can be \"sf-symbol\" or \"asset\"\n * - for sf-symbol, icon should be the symbol name\n * - for asset, icon should be the asset name\n * @since 6.7.0\n * @example\n * buttonNearDone: {\n * ios: {\n * iconType: \"sf-symbol\",\n * icon: \"star.fill\"\n * },\n * android: {\n * iconType: \"asset\",\n * icon: \"public/monkey.svg\",\n * width: 24,\n * height: 24\n * }\n * }\n * Test URL: https://capgo.app\n */\n buttonNearDone?: {\n ios: {\n iconType: 'sf-symbol' | 'asset';\n icon: string;\n };\n android: {\n iconType: 'asset' | 'vector';\n icon: string;\n width?: number;\n height?: number;\n };\n };\n /**\n * Shows a native screenshot button near the done/close button.\n * The button is hidden by default and captures the current viewport when tapped.\n * This option uses the same toolbar slot as `buttonNearDone` and is therefore incompatible with it.\n * The button is only shown when toolbarType is not \"activity\", \"navigation\", or \"blank\".\n *\n * @default false\n * @since 8.4.0\n */\n showScreenshotButton?: boolean;\n /**\n * textZoom: sets the text zoom of the page in percent.\n * Allows users to increase or decrease the text size for better readability.\n * @since 7.6.0\n * @default 100\n * @example\n * textZoom: 120\n * Test URL: https://capgo.app\n */\n textZoom?: number;\n /**\n * enableZoom: enables pinch-to-zoom gestures in the Android WebView.\n * When true, built-in zoom controls are enabled and the zoom buttons are hidden.\n * **Android only** — ignored on iOS where zoom is enabled by default.\n * @since 8.5.0\n * @default false\n * @example\n * enableZoom: true\n */\n enableZoom?: boolean;\n /**\n * If true, deeplinks and external app hand-off are blocked and stay in the webview.\n * If false (default), custom schemes such as `tel:`, `mailto:`, and `sms:` open natively.\n * On iOS, listing a custom scheme under `LSApplicationQueriesSchemes` is only required when\n * you rely on `canOpenURL` for that scheme (for example `instagram://`). It is not required\n * for HTTPS `authorizedAppLinks`, and `mailto`/`tel`/`sms` open without that Info.plist entry.\n * @since 0.1.0\n * @default false\n * @example\n * preventDeeplink: true\n * Test URL: https://aasa-tester.capgo.app/\n */\n preventDeeplink?: boolean;\n\n /**\n * When true, HTTP and HTTPS links opened from `target=\"_blank\"` anchors stay in the current webview instead of spawning a popup or opening in the system browser.\n * By default, blank-target HTTP(S) links stay inside the plugin as managed popups that share cookies with the opener; enabling this option keeps everything in the same tab.\n * Custom schemes such as `tel:` and `mailto:` and authorized app links still prefer their native handlers unless `preventDeeplink` is enabled.\n *\n * @since 8.5.6\n * @default false\n * @example\n * openBlankTargetInWebView: true\n */\n openBlankTargetInWebView?: boolean;\n\n /**\n * List of base URLs whose hosts are treated as authorized App Links (Android) and Universal Links (iOS).\n *\n * - On both platforms, only HTTP(S) links whose host matches any entry in this list\n * will attempt to leave the in-app browser for the native / system handler.\n * - iOS tries a Universal Link first (`universalLinksOnly`), then falls back to a normal\n * system open (App Store, Safari, etc.). Only if both fail does the URL stay in-webview.\n * - Android uses an `ACTION_VIEW` intent for matching hosts.\n * - Matching is host-based (case-insensitive), ignoring the \"www.\" prefix.\n * - HTTPS hosts do not need `LSApplicationQueriesSchemes`; that Info.plist key is for\n * custom schemes like `instagram://`, not `https://instagram.com`.\n * - When `preventDeeplink` is enabled, all external handling is blocked regardless of this list.\n *\n * @example\n * ```ts\n * [\"https://example.com\", \"https://instagram.com\", \"https://apps.apple.com\"]\n * ```\n *\n * @since 7.12.0\n * @default []\n */\n authorizedAppLinks?: string[];\n\n /**\n * If true, the webView will not take the full height and will have a 20px margin at the bottom.\n * This creates a safe margin area outside the browser view.\n * @since 7.13.0\n * @default false\n * @example\n * enabledSafeBottomMargin: true\n */\n enabledSafeBottomMargin?: boolean;\n\n /**\n * If false, the webView will extend behind the status bar for true full-screen immersive content.\n * When true (default), respects the safe area at the top of the screen.\n * Works independently of toolbarType - use for full-screen video players, games, or immersive web apps.\n * @since 8.2.0\n * @default true\n * @example\n * enabledSafeTopMargin: false // Full screen, extends behind status bar\n */\n enabledSafeTopMargin?: boolean;\n\n /**\n * When true, applies the system status bar inset as the WebView top margin on Android.\n * Keeps the legacy 0px margin by default for apps that handle padding themselves.\n * @default false\n * @example\n * useTopInset: true\n */\n useTopInset?: boolean;\n\n /**\n * enableGooglePaySupport: if true, enables support for Google Pay popups and Payment Request API.\n * This fixes OR_BIBED_15 errors by allowing popup windows and configuring Cross-Origin-Opener-Policy.\n * Only enable this if you need Google Pay functionality as it allows popup windows.\n *\n * When enabled:\n * - Allows popup windows for Google Pay authentication\n * - Sets proper CORS headers for Payment Request API\n * - Enables multiple window support in WebView\n * - Configures secure context for payment processing\n *\n * @since 7.13.0\n * @default false\n * @example\n * enableGooglePaySupport: true\n * Test URL: https://developers.google.com/pay/api/web/guides/tutorial\n */\n enableGooglePaySupport?: boolean;\n\n /**\n * Opens popup windows created by the page in hidden mode.\n * Hidden popup windows can still be controlled with `executeScript`, `postMessage`, `show`, and `close`.\n * Listen to `popupWindowOpened` to capture the popup id, then call `show({ id })` only if you want to reveal it.\n *\n * @default false\n * @since 8.6.0\n * @example\n * hiddenPopupWindow: true\n */\n hiddenPopupWindow?: boolean;\n\n /**\n * blockedHosts: List of host patterns that should be blocked from loading in the InAppBrowser's internal navigations.\n * Any request inside WebView to a URL with a host matching any of these patterns will be blocked.\n * Supports wildcard patterns like:\n * - \"*.example.com\" to block all subdomains\n * - \"www.example.*\" to block wildcard domain extensions\n *\n * @since 7.17.0\n * @default []\n * @example\n * blockedHosts: [\"*.tracking.com\", \"ads.example.com\"]\n */\n blockedHosts?: string[];\n\n /**\n * Width of the webview in screen/window points.\n * If not set, webview will be fullscreen width.\n * @default undefined (fullscreen)\n * @example\n * width: 400\n */\n width?: number;\n\n /**\n * Height of the webview in screen/window points.\n * Required for custom-sized (non-fullscreen) webviews.\n * @default undefined (fullscreen)\n * @example\n * height: 600\n */\n height?: number;\n\n /**\n * X position of the webview in screen/window points from the left edge.\n * Only effective when custom height is set.\n * @default 0\n * @example\n * x: 50\n */\n x?: number;\n\n /**\n * Y position of the webview in screen/window points from the top edge.\n * Only effective when custom height is set.\n * @default 0\n * @example\n * y: 100\n */\n y?: number;\n\n /**\n * Places the native browser behind the Capacitor host WebView.\n * Make the app background transparent to reveal it, or rely on `transparentBackground` to clear the host WebView.\n *\n * @default false\n */\n toBack?: boolean;\n\n /**\n * When `toBack` is true, makes the Capacitor host WebView transparent so the native browser can be seen behind Ionic content.\n * Ignored when the browser is in front.\n *\n * @default true\n */\n transparentBackground?: boolean;\n\n /**\n * Disables the bounce (overscroll) effect on iOS WebView.\n * When enabled, prevents the rubber band scrolling effect when users scroll beyond content boundaries.\n * This is useful for:\n * - Creating a more native, app-like experience\n * - Preventing accidental overscroll states\n * - Avoiding issues when keyboard opens/closes\n *\n * Note: This option only affects iOS. Android does not have this bounce effect by default.\n *\n * @since 8.0.2\n * @default false\n * @example\n * disableOverscroll: true\n */\n disableOverscroll?: boolean;\n\n /**\n * Opens the webview in hidden mode (not visible to user but fully functional).\n * When hidden, the webview loads and executes JavaScript but is not displayed.\n * All control methods (executeScript, postMessage, setUrl, etc.) work while hidden.\n * Use close() to clean up the hidden webview when done.\n *\n * @since 8.0.7\n * @default false\n * @example\n * hidden: true\n */\n hidden?: boolean;\n\n /**\n * Controls how a hidden webview reports its visibility and size.\n * - AWARE: webview is aware it's hidden (dimensions may be zero).\n * - FAKE_VISIBLE: webview is hidden but reports fullscreen dimensions (uses alpha=0 to remain invisible).\n *\n * @default InvisibilityMode.AWARE\n * @example\n * invisibilityMode: InvisibilityMode.FAKE_VISIBLE\n */\n invisibilityMode?: InvisibilityMode;\n}\n\nexport interface DimensionOptions {\n /**\n * Width of the webview in pixels\n */\n width?: number;\n /**\n * Height of the webview in pixels\n */\n height?: number;\n /**\n * X position from the left edge in pixels\n */\n x?: number;\n /**\n * Y position from the top edge in pixels\n */\n y?: number;\n}\n\nexport interface InAppBrowserPlugin {\n /**\n * Navigates back in the WebView's history if possible\n *\n * @since 7.21.0\n * @returns Promise that resolves with true if navigation was possible, false otherwise\n */\n goBack(options?: { id?: string }): Promise<{ canGoBack: boolean }>;\n\n /**\n * Open url in a new window fullscreen, on android it use chrome custom tabs, on ios it use SFSafariViewController\n *\n * @since 0.1.0\n */\n open(options: OpenOptions): Promise<any>;\n\n /**\n * Clear cookies of url\n * When `id` is omitted, applies to all open webviews.\n *\n * @since 0.5.0\n */\n clearCookies(options: ClearCookieOptions): Promise<any>;\n /**\n * Clear all cookies\n * When `id` is omitted, applies to all open webviews.\n *\n * @since 6.5.0\n */\n clearAllCookies(options?: { id?: string }): Promise<any>;\n\n /**\n * Clear cache\n * When `id` is omitted, applies to all open webviews.\n *\n * @since 6.5.0\n */\n clearCache(options?: { id?: string }): Promise<any>;\n\n /**\n * Clear all browsing data from the default store and any opened managed webviews.\n *\n * This removes cookies, disk cache, memory cache, local storage, session storage, IndexedDB,\n * WebSQL where supported, form data, and HTTP auth data where the platform exposes it.\n *\n * @since 8.6.36\n */\n clearAllBrowsingData(): Promise<any>;\n\n /**\n * Get cookies for a specific URL.\n * @param options The options, including the URL to get cookies for.\n * @returns A promise that resolves with the cookies.\n */\n getCookies(options: GetCookieOptions): Promise<Record<string, string>>;\n /**\n * Close the webview.\n * When `id` is omitted, closes the active webview.\n */\n close(options?: CloseWebviewOptions): Promise<any>;\n /**\n * Hide the webview without closing it.\n * Use show() to bring it back.\n * When `id` is omitted, targets the active webview.\n *\n * @since 8.0.8\n */\n hide(options?: { id?: string }): Promise<void>;\n /**\n * Show a previously hidden webview.\n * When `id` is omitted, targets the active webview.\n *\n * @since 8.0.8\n */\n show(options?: { id?: string }): Promise<void>;\n /**\n * Moves the native browser behind the Capacitor host WebView.\n * Use `dispatchInputEvent()` to forward overlay gestures to the browser while it is behind the app UI.\n */\n sendToBack(options?: LayerOptions): Promise<void>;\n /**\n * Moves a browser that was behind the host WebView back to the front.\n * On iOS, set `isAnimated` to `false` to skip the presentation animation.\n * When `id` is omitted, targets the active webview.\n */\n bringToFront(options?: BringToFrontOptions): Promise<void>;\n /**\n * Dispatches a click, touch, or scroll event to a managed browser.\n * Coordinates are relative to the browser viewport in CSS pixels.\n */\n dispatchInputEvent(options: DispatchInputEventOptions): Promise<void>;\n /**\n * Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.\n *\n * JavaScript Interface:\n * When you open a webview with this method, a JavaScript interface is automatically injected that provides:\n * - `window.mobileApp.close()`: Closes the webview from JavaScript\n * - `window.mobileApp.postMessage({detail: {message: \"myMessage\"}})`: Sends a message from the webview to the app, detail object is the data you want to send to the webview\n * - `window.mobileApp.takeScreenshot()` when `allowScreenshotsFromWebPage` is true\n *\n * Promise timing differs by platform when `isPresentAfterPageLoad` is used.\n * Android resolves with `{ id }` after the dialog is ready to control, while iOS resolves with `{ id }` immediately after creating the native webview.\n *\n * @returns Promise that resolves with the created webview id.\n * @since 0.1.0\n */\n openWebView(options: OpenWebViewOptions): Promise<{ id: string }>;\n /**\n * Injects JavaScript code into the InAppBrowser window.\n * When `id` is omitted, executes in all open webviews.\n */\n executeScript(options: { code: string; id?: string }): Promise<void>;\n /**\n * Sends an event to the webview(inappbrowser). you can listen to this event in the inappbrowser JS with window.addEventListener(\"messageFromNative\", listenerFunc: (event: Record<string, any>) => void)\n * detail is the data you want to send to the webview, it's a requirement of Capacitor we cannot send direct objects\n * Your object has to be serializable to JSON, so no functions or other non-JSON-serializable types are allowed.\n * When `id` is omitted, broadcasts to all open webviews.\n */\n postMessage(options: { detail: Record<string, any>; id?: string }): Promise<void>;\n /**\n * Captures the current webview viewport as a PNG screenshot.\n * When `id` is omitted, targets the active webview.\n *\n * On iOS, when testing through Apple's iPhone Mirroring app with the physical\n * device locked, the snapshot can succeed with the correct dimensions but a\n * fully transparent PNG. Capture works as expected on a normal unlocked device.\n */\n takeScreenshot(options?: { id?: string }): Promise<ScreenshotResult>;\n /**\n * Sets the URL of the webview.\n * When `id` is omitted, targets the active webview.\n */\n setUrl(options: { url: string; id?: string }): Promise<any>;\n /**\n * Listen for url change, only for openWebView\n *\n * @since 0.0.1\n */\n addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener): Promise<PluginListenerHandle>;\n\n /**\n * Listen for buttonNearDone clicks.\n *\n * The event payload contains the webview `id`.\n *\n * @since 0.0.1\n */\n addListener(eventName: 'buttonNearDoneClick', listenerFunc: ButtonNearListener): Promise<PluginListenerHandle>;\n\n /**\n * Listen for close click only for openWebView\n *\n * @since 0.4.0\n */\n addListener(eventName: 'closeEvent', listenerFunc: UrlChangeListener): Promise<PluginListenerHandle>;\n /**\n * Listen for webviews hidden by the toolbar close button when closeAction is CloseAction.HIDE.\n *\n * @since 8.7.7\n */\n addListener(eventName: 'hideEvent', listenerFunc: HideListener): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when user clicks on confirm button when disclaimer is required,\n * works with openWebView shareDisclaimer and closeModal\n *\n * @since 0.0.1\n */\n addListener(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when event is sent from webview(inappbrowser), to send an event to the main app use window.mobileApp.postMessage({ \"detail\": { \"message\": \"myMessage\" } })\n * detail is the data you want to send to the main app, it's a requirement of Capacitor we cannot send direct objects\n * Your object has to be serializable to JSON, no functions or other non-JSON-serializable types are allowed.\n *\n * This method is inject at runtime in the webview\n */\n addListener(\n eventName: 'messageFromWebview',\n listenerFunc: (event: { id?: string; detail?: Record<string, any>; rawMessage?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered whenever a screenshot is captured from the plugin API,\n * the native screenshot button, or the injected JavaScript bridge.\n */\n addListener(\n eventName: 'screenshotTaken',\n listenerFunc: (event: ScreenshotResult & { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered when page is loaded\n */\n addListener(\n eventName: 'browserPageLoaded',\n listenerFunc: (event: { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered when a main-frame page load starts (link navigation, reload, etc.).\n *\n * @since 8.11.0\n */\n addListener(\n eventName: 'browserPageLoadStart',\n listenerFunc: (event: { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered as a main-frame page load progresses.\n * `progress` is a value from `0` to `1`.\n *\n * @since 8.11.0\n */\n addListener(\n eventName: 'browserPageLoadProgress',\n listenerFunc: (event: { id?: string; progress: number }) => void,\n ): Promise<PluginListenerHandle>;\n\n /**\n * Will be triggered when page load error\n */\n addListener(\n eventName: 'pageLoadError',\n listenerFunc: (event: { id?: string }) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when the webview intercepts a non-standard custom scheme\n * and hands it to the operating system.\n *\n * Standard OS-handled schemes such as `tel:`, `mailto:`, and `sms:` are excluded.\n *\n * @since 8.6.7\n */\n addListener(\n eventName: 'customSchemeIntercepted',\n listenerFunc: CustomSchemeInterceptedListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered after native download handling saves a file locally.\n * Enable this with `handleDownloads: true` when opening the webview.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'downloadCompleted',\n listenerFunc: (event: DownloadCompletedEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered when native download handling fails.\n * Enable this with `handleDownloads: true` when opening the webview.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'downloadFailed',\n listenerFunc: (event: DownloadFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Will be triggered whenever a page opens a popup/new window.\n * Use the returned popup id with `executeScript`, `postMessage`, `show`, `hide`, and `close`.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'popupWindowOpened',\n listenerFunc: (event: PopupWindowEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for proxied requests delegated by the native runtime.\n * Prefer `addProxyHandler()` instead of calling this directly.\n *\n * @since 8.6.0\n */\n addListener(eventName: 'proxyRequest', listenerFunc: (event: ProxyRequest) => void): Promise<PluginListenerHandle>;\n /**\n * Listen for JavaScript console output emitted by the managed page.\n * Enable this with `captureConsoleLogs: true` when opening the webview.\n *\n * @since 8.6.0\n */\n addListener(\n eventName: 'consoleMessage',\n listenerFunc: (event: ConsoleMessageEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Internal method used by `addProxyHandler()` to send a proxy decision back to native.\n * Forward the original `phase` when replying to a manual `proxyRequest` listener.\n *\n * @since 8.6.0\n */\n handleProxyRequest(options: {\n requestId: string;\n decision?: ProxyDecision | null;\n response?: ProxyResponse | null;\n webviewId?: string;\n phase?: 'outbound' | 'inbound';\n }): Promise<void>;\n /**\n * Remove all listeners for this plugin.\n *\n * @since 1.0.0\n */\n removeAllListeners(): Promise<void>;\n\n /**\n * Reload the current web page.\n *\n * @since 1.0.0\n */\n reload(options?: { id?: string }): Promise<any>;\n\n /**\n * Update the dimensions of the webview.\n * Allows changing the size and position of the webview at runtime.\n * When `id` is omitted, targets the active webview.\n *\n * @param options Dimension options (width, height, x, y)\n * @returns Promise that resolves when dimensions are updated\n */\n updateDimensions(options: DimensionOptions & { id?: string }): Promise<void>;\n\n /**\n * Sets the enabled safe top margin of the webview at runtime.\n * When `id` is omitted, targets the active webview.\n * On Web, this method is a no-op and resolves without changing layout.\n */\n setEnabledSafeTopMargin(options: { enabled: boolean; id?: string }): Promise<void>;\n\n /**\n * Sets the enabled safe bottom margin of the webview at runtime.\n * When `id` is omitted, targets the active webview.\n * On Web, this method is a no-op and resolves without changing layout.\n */\n setEnabledSafeBottomMargin(options: { enabled: boolean; id?: string }): Promise<void>;\n\n /**\n * Opens a secured window for OAuth2 authentication.\n *\n * On web, the redirect page should post the final URL to a `BroadcastChannel` and close itself.\n * On mobile, register a custom redirect URI scheme (for example `myapp://oauth_callback/`) in Info.plist and AndroidManifest.xml.\n * See the README section \"openSecureWindow (OAuth)\" for full setup examples.\n *\n * @param options - the options for the openSecureWindow call\n */\n openSecureWindow(options: OpenSecureWindowOptions): Promise<OpenSecureWindowResponse>;\n}\n\n/**\n * JavaScript APIs available in the InAppBrowser WebView.\n *\n * These APIs are automatically injected into all webpages loaded in the InAppBrowser WebView.\n *\n * @example\n * // Closing the webview from JavaScript\n * window.mobileApp.close();\n *\n * // Sending a message from webview to the native app\n * window.mobileApp.postMessage({ key: \"value\" });\n *\n * @since 6.10.0\n */\nexport interface InAppBrowserWebViewAPIs {\n /**\n * mobileApp - Global object injected into the WebView providing communication with the native app\n */\n mobileApp: {\n /**\n * Close the WebView from JavaScript\n *\n * @example\n * // Add a button to close the webview\n * const closeButton = document.createElement(\"button\");\n * closeButton.textContent = \"Close WebView\";\n * closeButton.addEventListener(\"click\", () => {\n * window.mobileApp.close();\n * });\n * document.body.appendChild(closeButton);\n *\n * @since 6.10.0\n */\n close(): void;\n\n /**\n * Send a message from the WebView to the native app\n * The native app can listen for these messages with the \"messageFromWebview\" event\n *\n * @param message Object to send to the native app\n * @example\n * // Send data to native app\n * window.mobileApp.postMessage({\n * action: \"dataSubmitted\",\n * data: { username: \"test\", email: \"test@example.com\" }\n * });\n *\n * @since 6.10.0\n */\n postMessage(message: Record<string, any>): void;\n\n /**\n * Hide the WebView from JavaScript (requires allowWebViewJsVisibilityControl: true in CapacitorConfig)\n *\n * @since 8.0.8\n */\n hide(): void;\n\n /**\n * Show the WebView from JavaScript (requires allowWebViewJsVisibilityControl: true in CapacitorConfig)\n *\n * @since 8.0.8\n */\n show(): void;\n\n /**\n * Capture the current WebView viewport as a PNG screenshot.\n * Requires `allowScreenshotsFromWebPage` to be enabled when opening the webview.\n *\n * @since 8.4.0\n */\n takeScreenshot(): Promise<ScreenshotResult>;\n };\n\n /**\n * Get the native Capacitor plugin version\n *\n * @returns {Promise<{ id: string }>} an Promise with version for this device\n * @throws An error if the something went wrong\n */\n getPluginVersion(): Promise<{ version: string }>;\n}\n"]}
@@ -249,6 +249,51 @@ enum CustomWebViewFrameSupport {
249
249
  }
250
250
  }
251
251
 
252
+ enum ReloadGestureSupport {
253
+ /// Ordinary page finishes must not clear an armed pull still held by the user.
254
+ static func shouldApplyStopReloadGesture(reloadFromGestureInProgress: Bool) -> Bool {
255
+ reloadFromGestureInProgress
256
+ }
257
+
258
+ /// UIRefreshControl may fire valueChanged while the finger is still down.
259
+ /// Match browser UX: commit reload only after touch end.
260
+ static func shouldDeferReloadUntilTouchEnd(isTracking: Bool, isDragging: Bool) -> Bool {
261
+ isTracking || isDragging
262
+ }
263
+
264
+ /// Pull distance below the resting top (adjusted inset). Positive when overscrolling down.
265
+ static func pullDistance(contentOffsetY: CGFloat, adjustedContentInsetTop: CGFloat) -> CGFloat {
266
+ max(0, -(contentOffsetY + adjustedContentInsetTop))
267
+ }
268
+
269
+ /// After intentional touch end, reload only if still near the activation pull distance
270
+ /// captured when UIRefreshControl fired `.valueChanged` (not a fixed constant).
271
+ static func shouldReloadOnTouchEnd(
272
+ pendingReload: Bool,
273
+ currentPullDistance: CGFloat,
274
+ armedPullDistance: CGFloat
275
+ ) -> Bool {
276
+ guard pendingReload, armedPullDistance > 0 else { return false }
277
+ // Allow slight finger jitter below the exact activation point.
278
+ return currentPullDistance >= armedPullDistance * 0.9
279
+ }
280
+
281
+ /// Resting offset after gesture reload.
282
+ /// Plugin safe-area uses CSS variables with `contentInset = .zero`, so forced reset is always `0`.
283
+ /// - Parameter forceToRestingTop: After gesture reload, snap to top. Otherwise only un-overscroll.
284
+ static func contentOffsetYAfterReloadReset(
285
+ currentY: CGFloat,
286
+ adjustedContentInsetTop: CGFloat,
287
+ forceToRestingTop: Bool = false
288
+ ) -> CGFloat {
289
+ if forceToRestingTop {
290
+ return 0
291
+ }
292
+ let restingY = -adjustedContentInsetTop
293
+ return currentY < restingY ? restingY : currentY
294
+ }
295
+ }
296
+
252
297
  extension UIColor {
253
298
 
254
299
  convenience init(hexString: String) {
@@ -275,7 +320,7 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
275
320
  case aware = "AWARE"
276
321
  case fakeVisible = "FAKE_VISIBLE"
277
322
  }
278
- private let pluginVersion: String = "8.12.3"
323
+ private let pluginVersion: String = "8.13.1"
279
324
  public let identifier = "CapgoInAppBrowserPlugin"
280
325
  public let jsName = "CapgoInAppBrowser"
281
326
  public let pluginMethods: [CAPPluginMethod] = [
@@ -1358,6 +1403,9 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
1358
1403
  webViewController.openBlankTargetInWebView = openBlankTargetInWebView
1359
1404
  webViewController.persistWebViewData = persistWebViewData
1360
1405
  webViewController.setHeaders(headers: headers)
1406
+ if let customUserAgent = call.getString("customUserAgent"), !customUserAgent.isEmpty {
1407
+ webViewController.customUserAgent = customUserAgent
1408
+ }
1361
1409
  webViewController.setPreventDeeplink(preventDeeplink: preventDeeplink)
1362
1410
  webViewController.setBlockedHosts(blockedHosts: blockedHosts)
1363
1411
  webViewController.setAuthorizedAppLinks(authorizedAppLinks: authorizedAppLinks)
@@ -0,0 +1,170 @@
1
+ import UIKit
2
+ import WebKit
3
+
4
+ extension WKWebViewController {
5
+ func configureReloadGesture(for targetWebView: WKWebView) {
6
+ if let existing = targetWebView.scrollView.refreshControl {
7
+ existing.endRefreshing()
8
+ existing.removeTarget(nil, action: nil, for: .allEvents)
9
+ targetWebView.scrollView.refreshControl = nil
10
+ }
11
+
12
+ // UIRefreshControl can leave sticky insets that clip the page header after reload.
13
+ targetWebView.scrollView.contentInset = .zero
14
+ targetWebView.scrollView.scrollIndicatorInsets = .zero
15
+
16
+ guard enableReloadGesture, !disableOverscroll else {
17
+ pendingReloadFromGesture = false
18
+ reloadGestureArmedPullDistance = 0
19
+ return
20
+ }
21
+
22
+ targetWebView.scrollView.alwaysBounceVertical = true
23
+ let refreshControl = UIRefreshControl()
24
+ refreshControl.addTarget(self, action: #selector(handleReloadGesture(_:)), for: .valueChanged)
25
+ targetWebView.scrollView.refreshControl = refreshControl
26
+
27
+ if !reloadPanObserverInstalled {
28
+ targetWebView.scrollView.panGestureRecognizer.addTarget(
29
+ self,
30
+ action: #selector(handleReloadPanGesture(_:))
31
+ )
32
+ reloadPanObserverInstalled = true
33
+ }
34
+ }
35
+
36
+ @objc func handleReloadGesture(_: UIRefreshControl) {
37
+ guard let scrollView = self.capableWebView?.scrollView else {
38
+ performReloadFromGesture()
39
+ return
40
+ }
41
+
42
+ // Defer until finger leaves so a pull past threshold then cancel does not reload.
43
+ if ReloadGestureSupport.shouldDeferReloadUntilTouchEnd(
44
+ isTracking: scrollView.isTracking,
45
+ isDragging: scrollView.isDragging
46
+ ) {
47
+ pendingReloadFromGesture = true
48
+ reloadGestureArmedPullDistance = ReloadGestureSupport.pullDistance(
49
+ contentOffsetY: scrollView.contentOffset.y,
50
+ adjustedContentInsetTop: scrollView.adjustedContentInset.top
51
+ )
52
+ return
53
+ }
54
+
55
+ performReloadFromGesture()
56
+ }
57
+
58
+ @objc func handleReloadPanGesture(_ gesture: UIPanGestureRecognizer) {
59
+ guard enableReloadGesture else { return }
60
+ guard let scrollView = self.capableWebView?.scrollView else { return }
61
+
62
+ switch gesture.state {
63
+ case .ended:
64
+ let pullDistance = ReloadGestureSupport.pullDistance(
65
+ contentOffsetY: scrollView.contentOffset.y,
66
+ adjustedContentInsetTop: scrollView.adjustedContentInset.top
67
+ )
68
+ let shouldReload = ReloadGestureSupport.shouldReloadOnTouchEnd(
69
+ pendingReload: pendingReloadFromGesture,
70
+ currentPullDistance: pullDistance,
71
+ armedPullDistance: reloadGestureArmedPullDistance
72
+ )
73
+ pendingReloadFromGesture = false
74
+ reloadGestureArmedPullDistance = 0
75
+
76
+ if shouldReload {
77
+ performReloadFromGesture()
78
+ } else if !reloadFromGestureInProgress,
79
+ scrollView.refreshControl?.isRefreshing == true {
80
+ scrollView.refreshControl?.endRefreshing()
81
+ hardResetReloadGestureScroll(on: scrollView)
82
+ }
83
+
84
+ case .cancelled, .failed:
85
+ pendingReloadFromGesture = false
86
+ reloadGestureArmedPullDistance = 0
87
+ guard !reloadFromGestureInProgress else { break }
88
+ if scrollView.refreshControl?.isRefreshing == true {
89
+ scrollView.refreshControl?.endRefreshing()
90
+ hardResetReloadGestureScroll(on: scrollView)
91
+ }
92
+
93
+ default:
94
+ break
95
+ }
96
+ }
97
+
98
+ private func performReloadFromGesture() {
99
+ pendingReloadFromGesture = false
100
+ reloadGestureArmedPullDistance = 0
101
+ reloadFromGestureInProgress = true
102
+
103
+ guard let webView = self.capableWebView else {
104
+ stopReloadGesture()
105
+ return
106
+ }
107
+
108
+ // `reload()` preserves broken scroll/inset state after UIRefreshControl.
109
+ // A fresh URL load matches a normal navigation and resets scroll like the reporter's "proper" reload.
110
+ if let url = webView.url {
111
+ reloadGestureNavigation = webView.load(URLRequest(url: url))
112
+ } else {
113
+ reloadGestureNavigation = webView.reload()
114
+ }
115
+
116
+ if reloadGestureNavigation == nil {
117
+ stopReloadGesture()
118
+ }
119
+ }
120
+
121
+ private func hardResetReloadGestureScroll(on scrollView: UIScrollView) {
122
+ scrollView.contentInset = .zero
123
+ scrollView.scrollIndicatorInsets = .zero
124
+ let resetY = ReloadGestureSupport.contentOffsetYAfterReloadReset(
125
+ currentY: scrollView.contentOffset.y,
126
+ adjustedContentInsetTop: 0,
127
+ forceToRestingTop: true
128
+ )
129
+ if scrollView.contentOffset.y != resetY || scrollView.contentOffset.x != 0 {
130
+ scrollView.setContentOffset(CGPoint(x: 0, y: resetY), animated: false)
131
+ }
132
+ }
133
+
134
+ func stopReloadGesture(for navigation: WKNavigation? = nil) {
135
+ guard ReloadGestureSupport.shouldApplyStopReloadGesture(
136
+ reloadFromGestureInProgress: reloadFromGestureInProgress
137
+ ) else { return }
138
+
139
+ if let expected = reloadGestureNavigation,
140
+ let navigation,
141
+ expected !== navigation {
142
+ return
143
+ }
144
+
145
+ pendingReloadFromGesture = false
146
+ reloadFromGestureInProgress = false
147
+ reloadGestureNavigation = nil
148
+ reloadGestureArmedPullDistance = 0
149
+
150
+ guard let activeWebView = self.capableWebView else { return }
151
+ activeWebView.scrollView.refreshControl?.endRefreshing()
152
+
153
+ // Reset after the current runloop so WKWebView finishes applying navigation scroll state.
154
+ DispatchQueue.main.async { [weak self] in
155
+ guard let self, let activeWebView = self.capableWebView else { return }
156
+ let scrollView = activeWebView.scrollView
157
+ scrollView.refreshControl?.endRefreshing()
158
+ self.hardResetReloadGestureScroll(on: scrollView)
159
+ self.configureReloadGesture(for: activeWebView)
160
+ self.hardResetReloadGestureScroll(on: activeWebView.scrollView)
161
+ activeWebView.evaluateJavaScript("window.scrollTo(0, 0);", completionHandler: nil)
162
+
163
+ // One more pass after layout / JS scroll restoration.
164
+ DispatchQueue.main.async { [weak self] in
165
+ guard let self, let activeWebView = self.capableWebView else { return }
166
+ self.hardResetReloadGestureScroll(on: activeWebView.scrollView)
167
+ }
168
+ }
169
+ }
170
+ }
@@ -472,6 +472,11 @@ open class WKWebViewController: UIViewController, WKScriptMessageHandler {
472
472
  var authorizedAppLinks: [String] = []
473
473
  var activeNativeNavigationForWebview: Bool = true
474
474
  var enableReloadGesture: Bool = false
475
+ var pendingReloadFromGesture = false
476
+ var reloadFromGestureInProgress = false
477
+ var reloadGestureNavigation: WKNavigation?
478
+ var reloadGestureArmedPullDistance: CGFloat = 0
479
+ var reloadPanObserverInstalled = false
475
480
  var disableOverscroll: Bool = false
476
481
  var proxyRequests: Bool = false
477
482
  var proxySchemeHandler: ProxySchemeHandler?
@@ -2562,36 +2567,20 @@ public extension WKWebViewController {
2562
2567
  self.webView?.allowsBackForwardNavigationGestures = self.activeNativeNavigationForWebview
2563
2568
  }
2564
2569
 
2565
- private func configureReloadGesture(for webView: WKWebView) {
2566
- if let existing = webView.scrollView.refreshControl {
2567
- existing.endRefreshing()
2568
- existing.removeTarget(nil, action: nil, for: .allEvents)
2569
- webView.scrollView.refreshControl = nil
2570
- }
2571
-
2572
- guard enableReloadGesture, !disableOverscroll else {
2573
- return
2574
- }
2575
-
2576
- webView.scrollView.alwaysBounceVertical = true
2577
- let refreshControl = UIRefreshControl()
2578
- refreshControl.addTarget(self, action: #selector(handleReloadGesture(_:)), for: .valueChanged)
2579
- webView.scrollView.refreshControl = refreshControl
2580
- }
2581
-
2582
- @objc private func handleReloadGesture(_ sender: UIRefreshControl) {
2583
- reload()
2584
- }
2585
-
2586
- private func stopReloadGesture() {
2587
- webView?.scrollView.refreshControl?.endRefreshing()
2588
- }
2589
-
2590
2570
  func cleanupWebView() {
2591
2571
  guard let webView = self.webView else { return }
2592
2572
  webView.stopLoading()
2593
2573
  previewItemURL = nil
2594
2574
 
2575
+ if reloadPanObserverInstalled {
2576
+ webView.scrollView.panGestureRecognizer.removeTarget(self, action: #selector(handleReloadPanGesture(_:)))
2577
+ reloadPanObserverInstalled = false
2578
+ }
2579
+ pendingReloadFromGesture = false
2580
+ reloadFromGestureInProgress = false
2581
+ reloadGestureNavigation = nil
2582
+ reloadGestureArmedPullDistance = 0
2583
+
2595
2584
  // Remove KVO observers FIRST, before any operation that could trigger them
2596
2585
  webView.removeObserver(self, forKeyPath: estimatedProgressKeyPath)
2597
2586
  if websiteTitleInNavigationBar {
@@ -3534,10 +3523,11 @@ extension WKWebViewController: WKNavigationDelegate {
3534
3523
  delegate?.webViewController?(self, didFinish: url)
3535
3524
  }
3536
3525
  self.injectJavaScriptInterface()
3526
+ // End refresh + clear sticky insets before safe-area sync zeroes contentInset.
3527
+ stopReloadGesture(for: navigation)
3537
3528
  lastInjectedSafeAreaInsets = nil
3538
3529
  syncWebViewSafeAreaLayout()
3539
3530
  emit("browserPageLoaded")
3540
- stopReloadGesture()
3541
3531
  }
3542
3532
 
3543
3533
  public func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: Error) {
@@ -3547,7 +3537,7 @@ extension WKWebViewController: WKNavigationDelegate {
3547
3537
  self.url = url
3548
3538
  delegate?.webViewController?(self, didFail: url, withError: error)
3549
3539
  }
3550
- stopReloadGesture()
3540
+ stopReloadGesture(for: navigation)
3551
3541
  emit("pageLoadError")
3552
3542
  }
3553
3543
 
@@ -3558,7 +3548,7 @@ extension WKWebViewController: WKNavigationDelegate {
3558
3548
  self.url = url
3559
3549
  delegate?.webViewController?(self, didFail: url, withError: error)
3560
3550
  }
3561
- stopReloadGesture()
3551
+ stopReloadGesture(for: navigation)
3562
3552
  emit("pageLoadError")
3563
3553
  }
3564
3554
 
@@ -3688,10 +3678,16 @@ extension WKWebViewController: WKNavigationDelegate {
3688
3678
 
3689
3679
  public func webView(_ webView: WKWebView, navigationAction: WKNavigationAction, didBecome download: WKDownload) {
3690
3680
  register(download: download, response: nil, sourceURL: navigationAction.request.url?.absoluteString)
3681
+ stopReloadGesture()
3691
3682
  }
3692
3683
 
3693
3684
  public func webView(_ webView: WKWebView, navigationResponse: WKNavigationResponse, didBecome download: WKDownload) {
3694
3685
  register(download: download, response: navigationResponse.response)
3686
+ stopReloadGesture()
3687
+ }
3688
+
3689
+ public func webViewWebContentProcessDidTerminate(_ webView: WKWebView) {
3690
+ stopReloadGesture()
3695
3691
  }
3696
3692
 
3697
3693
  // MARK: - Dimension Management
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@capgo/capacitor-inappbrowser",
3
- "version": "8.12.3",
3
+ "version": "8.13.1",
4
4
  "description": "Capacitor plugin in app browser",
5
5
  "main": "dist/plugin.cjs.js",
6
6
  "module": "dist/esm/index.js",