@capgo/capacitor-inappbrowser 8.8.1 → 8.9.0
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 +24 -8
- package/android/src/main/java/ee/forgr/capacitor_inappbrowser/CapgoInAppBrowserPlugin.java +7 -2
- package/android/src/main/java/ee/forgr/capacitor_inappbrowser/Options.java +10 -0
- package/android/src/main/java/ee/forgr/capacitor_inappbrowser/WebViewCallbacks.java +1 -1
- package/android/src/main/java/ee/forgr/capacitor_inappbrowser/WebViewDialog.java +38 -6
- package/dist/docs.json +64 -3
- package/dist/esm/definitions.d.ts +27 -1
- package/dist/esm/definitions.js.map +1 -1
- package/ios/Sources/InAppBrowserPlugin/InAppBrowserPlugin.swift +13 -4
- package/ios/Sources/InAppBrowserPlugin/WKWebViewController.swift +24 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -150,19 +150,20 @@ await InAppBrowser.show({ id: second.id });
|
|
|
150
150
|
|
|
151
151
|
#### Hide from the native close button and brand the toolbar title
|
|
152
152
|
|
|
153
|
-
Use `closeAction: CloseAction.HIDE` when the toolbar close button should hide the WebView instead of destroying it. Listen to `hideEvent` if your app needs to update Ionic state, then call `show()` later to bring the same browser session back.
|
|
153
|
+
Use `closeAction: CloseAction.HIDE` when the toolbar close button should hide the WebView instead of destroying it. Listen to `hideEvent` if your app needs to update Ionic state, then call `show()` later to bring the same browser session back. Set `screenshotOnHide` to receive one last visible-page screenshot in that event.
|
|
154
154
|
|
|
155
155
|
```js
|
|
156
156
|
import { CloseAction, InAppBrowser } from '@capgo/capacitor-inappbrowser';
|
|
157
157
|
|
|
158
|
-
await InAppBrowser.addListener('hideEvent', ({ id, url }) => {
|
|
159
|
-
console.log('Browser hidden', id, url);
|
|
158
|
+
await InAppBrowser.addListener('hideEvent', ({ id, url, screenshot }) => {
|
|
159
|
+
console.log('Browser hidden', id, url, screenshot?.dataUrl);
|
|
160
160
|
});
|
|
161
161
|
|
|
162
162
|
const { id } = await InAppBrowser.openWebView({
|
|
163
163
|
url: 'https://example.com/checkout',
|
|
164
164
|
title: 'Secure checkout',
|
|
165
165
|
closeAction: CloseAction.HIDE,
|
|
166
|
+
screenshotOnHide: true,
|
|
166
167
|
titleFontFamily: 'Inter',
|
|
167
168
|
titleIcon: {
|
|
168
169
|
ios: { iconType: 'sf-symbol', icon: 'lock.fill' },
|
|
@@ -975,15 +976,15 @@ Listen for close click only for openWebView
|
|
|
975
976
|
### addListener('hideEvent', ...)
|
|
976
977
|
|
|
977
978
|
```typescript
|
|
978
|
-
addListener(eventName: 'hideEvent', listenerFunc:
|
|
979
|
+
addListener(eventName: 'hideEvent', listenerFunc: HideListener) => Promise<PluginListenerHandle>
|
|
979
980
|
```
|
|
980
981
|
|
|
981
982
|
Listen for webviews hidden by the toolbar close button when closeAction is <a href="#closeaction">CloseAction.HIDE</a>.
|
|
982
983
|
|
|
983
|
-
| Param | Type
|
|
984
|
-
| ------------------ |
|
|
985
|
-
| **`eventName`** | <code>'hideEvent'</code>
|
|
986
|
-
| **`listenerFunc`** | <code><a href="#
|
|
984
|
+
| Param | Type |
|
|
985
|
+
| ------------------ | ----------------------------------------------------- |
|
|
986
|
+
| **`eventName`** | <code>'hideEvent'</code> |
|
|
987
|
+
| **`listenerFunc`** | <code><a href="#hidelistener">HideListener</a></code> |
|
|
987
988
|
|
|
988
989
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
989
990
|
|
|
@@ -1489,6 +1490,7 @@ And in the AndroidManifest.xml file:
|
|
|
1489
1490
|
| **`isAnimated`** | <code>boolean</code> | Whether the webview opening is animated or not, ios only | <code>true</code> | |
|
|
1490
1491
|
| **`showReloadButton`** | <code>boolean</code> | Shows a reload button that reloads the web page | <code>false</code> | 1.0.15 |
|
|
1491
1492
|
| **`closeAction`** | <code><a href="#closeaction">CloseAction</a></code> | closeAction controls what happens when the native toolbar close button is pressed. This does not change the behavior of close(), JavaScript window.mobileApp.close(), or native back navigation. | <code>CloseAction.CLOSE</code> | 8.7.7 |
|
|
1493
|
+
| **`screenshotOnHide`** | <code>boolean</code> | Captures the visible webview and includes it as `screenshot` in `hideEvent` before the toolbar close button hides the webview. Only applies when `closeAction` is <a href="#closeaction">`CloseAction.HIDE`</a>. | <code>false</code> | 8.7.10 |
|
|
1492
1494
|
| **`closeModal`** | <code>boolean</code> | CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately. | <code>false</code> | 1.1.0 |
|
|
1493
1495
|
| **`closeModalTitle`** | <code>string</code> | CloseModalTitle: title of the confirm when user clicks on close button | <code>"Close"</code> | 1.1.0 |
|
|
1494
1496
|
| **`closeModalDescription`** | <code>string</code> | CloseModalDescription: description of the confirm when user clicks on close button | <code>"Are you sure you want to close this window?"</code> | 1.1.0 |
|
|
@@ -1612,6 +1614,15 @@ Any regex property that is omitted is treated as a wildcard.
|
|
|
1612
1614
|
| **`id`** | <code>string</code> | Webview instance id. | 8.6.36 |
|
|
1613
1615
|
|
|
1614
1616
|
|
|
1617
|
+
#### HideEvent
|
|
1618
|
+
|
|
1619
|
+
| Prop | Type | Description |
|
|
1620
|
+
| ---------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1621
|
+
| **`id`** | <code>string</code> | Webview instance id. |
|
|
1622
|
+
| **`url`** | <code>string</code> | URL active when the webview was hidden. |
|
|
1623
|
+
| **`screenshot`** | <code><a href="#screenshotresult">ScreenshotResult</a></code> | Screenshot captured immediately before the toolbar close button hides the webview. Present only when `screenshotOnHide` is enabled and capture succeeds. |
|
|
1624
|
+
|
|
1625
|
+
|
|
1615
1626
|
#### BtnEvent
|
|
1616
1627
|
|
|
1617
1628
|
| Prop | Type | Description | Since |
|
|
@@ -1837,6 +1848,11 @@ Construct a type with a set of properties K of type T
|
|
|
1837
1848
|
<code>(state: <a href="#buttonneardoneevent">ButtonNearDoneEvent</a>): void</code>
|
|
1838
1849
|
|
|
1839
1850
|
|
|
1851
|
+
#### HideListener
|
|
1852
|
+
|
|
1853
|
+
<code>(state: <a href="#hideevent">HideEvent</a>): void</code>
|
|
1854
|
+
|
|
1855
|
+
|
|
1840
1856
|
#### ConfirmBtnListener
|
|
1841
1857
|
|
|
1842
1858
|
<code>(state: <a href="#btnevent">BtnEvent</a>): void</code>
|
|
@@ -170,8 +170,12 @@ public class CapgoInAppBrowserPlugin extends Plugin implements WebViewDialog.Per
|
|
|
170
170
|
}
|
|
171
171
|
|
|
172
172
|
@Override
|
|
173
|
-
public void hideEvent(String url) {
|
|
174
|
-
|
|
173
|
+
public void hideEvent(String url, JSObject screenshot) {
|
|
174
|
+
JSObject event = new JSObject().put("id", webViewId).put("url", url);
|
|
175
|
+
if (screenshot != null) {
|
|
176
|
+
event.put("screenshot", screenshot);
|
|
177
|
+
}
|
|
178
|
+
notifyListeners("hideEvent", event);
|
|
175
179
|
}
|
|
176
180
|
|
|
177
181
|
@Override
|
|
@@ -1064,6 +1068,7 @@ public class CapgoInAppBrowserPlugin extends Plugin implements WebViewDialog.Per
|
|
|
1064
1068
|
options.setIgnoreUntrustedSSLError(Boolean.TRUE.equals(call.getBoolean("ignoreUntrustedSSLError", false)));
|
|
1065
1069
|
options.setClientCertificatePrompt(resolveClientCertificatePrompt(call));
|
|
1066
1070
|
options.setShowScreenshotButton(Boolean.TRUE.equals(call.getBoolean("showScreenshotButton", false)));
|
|
1071
|
+
options.setScreenshotOnHide(Boolean.TRUE.equals(call.getBoolean("screenshotOnHide", false)));
|
|
1067
1072
|
options.setAllowScreenshotsFromWebPage(Boolean.TRUE.equals(call.getBoolean("allowScreenshotsFromWebPage", false)));
|
|
1068
1073
|
options.setCaptureConsoleLogs(Boolean.TRUE.equals(call.getBoolean("captureConsoleLogs", false)));
|
|
1069
1074
|
options.setHandleDownloads(Boolean.TRUE.equals(call.getBoolean("handleDownloads", false)));
|
|
@@ -193,6 +193,7 @@ public class Options {
|
|
|
193
193
|
private boolean toBack = false;
|
|
194
194
|
private boolean transparentBackground = true;
|
|
195
195
|
private boolean showScreenshotButton = false;
|
|
196
|
+
private boolean screenshotOnHide = false;
|
|
196
197
|
private boolean allowWebViewJsVisibilityControl = false;
|
|
197
198
|
private boolean allowScreenshotsFromWebPage = false;
|
|
198
199
|
private boolean captureConsoleLogs = false;
|
|
@@ -272,6 +273,14 @@ public class Options {
|
|
|
272
273
|
this.showScreenshotButton = showScreenshotButton;
|
|
273
274
|
}
|
|
274
275
|
|
|
276
|
+
public boolean getScreenshotOnHide() {
|
|
277
|
+
return screenshotOnHide;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
public void setScreenshotOnHide(boolean screenshotOnHide) {
|
|
281
|
+
this.screenshotOnHide = screenshotOnHide;
|
|
282
|
+
}
|
|
283
|
+
|
|
275
284
|
public boolean getAllowScreenshotsFromWebPage() {
|
|
276
285
|
return allowScreenshotsFromWebPage;
|
|
277
286
|
}
|
|
@@ -787,6 +796,7 @@ public class Options {
|
|
|
787
796
|
copy.setY(y);
|
|
788
797
|
copy.setHidden(hidden || hiddenPopupWindow);
|
|
789
798
|
copy.setShowScreenshotButton(showScreenshotButton);
|
|
799
|
+
copy.setScreenshotOnHide(screenshotOnHide);
|
|
790
800
|
copy.setAllowWebViewJsVisibilityControl(allowWebViewJsVisibilityControl);
|
|
791
801
|
copy.setAllowScreenshotsFromWebPage(allowScreenshotsFromWebPage);
|
|
792
802
|
copy.setCaptureConsoleLogs(captureConsoleLogs);
|
|
@@ -352,6 +352,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
352
352
|
private Drawable cachedTitleIconDrawable;
|
|
353
353
|
private boolean cachedTitleIconResolved;
|
|
354
354
|
private boolean isHiddenModeActive = false;
|
|
355
|
+
private boolean toolbarHideInProgress = false;
|
|
355
356
|
private WindowManager.LayoutParams previousWindowAttributes;
|
|
356
357
|
private Drawable previousWindowBackground;
|
|
357
358
|
private ViewGroup.LayoutParams previousWebViewLayoutParams;
|
|
@@ -2912,6 +2913,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
2912
2913
|
}
|
|
2913
2914
|
}
|
|
2914
2915
|
} else {
|
|
2916
|
+
toolbarHideInProgress = false;
|
|
2915
2917
|
if (isHiddenModeActive) {
|
|
2916
2918
|
restoreVisibleMode();
|
|
2917
2919
|
}
|
|
@@ -3300,6 +3302,10 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
3300
3302
|
}
|
|
3301
3303
|
|
|
3302
3304
|
public void takeScreenshot(ScreenshotResultCallback callback) {
|
|
3305
|
+
takeScreenshot(true, callback);
|
|
3306
|
+
}
|
|
3307
|
+
|
|
3308
|
+
private void takeScreenshot(boolean emitEvent, ScreenshotResultCallback callback) {
|
|
3303
3309
|
if (_webView == null) {
|
|
3304
3310
|
callback.onError("WebView is not initialized");
|
|
3305
3311
|
return;
|
|
@@ -3344,7 +3350,7 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
3344
3350
|
result.put("width", width);
|
|
3345
3351
|
result.put("height", height);
|
|
3346
3352
|
|
|
3347
|
-
postScreenshotSuccess(callback, result);
|
|
3353
|
+
postScreenshotSuccess(callback, result, emitEvent);
|
|
3348
3354
|
} catch (IOException e) {
|
|
3349
3355
|
postScreenshotError(callback, "Failed to encode screenshot: " + e.getMessage());
|
|
3350
3356
|
} finally {
|
|
@@ -3354,13 +3360,13 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
3354
3360
|
});
|
|
3355
3361
|
}
|
|
3356
3362
|
|
|
3357
|
-
private void postScreenshotSuccess(ScreenshotResultCallback callback, JSObject result) {
|
|
3363
|
+
private void postScreenshotSuccess(ScreenshotResultCallback callback, JSObject result, boolean emitEvent) {
|
|
3358
3364
|
if (_webView == null) {
|
|
3359
3365
|
callback.onError("WebView is not initialized");
|
|
3360
3366
|
return;
|
|
3361
3367
|
}
|
|
3362
3368
|
_webView.post(() -> {
|
|
3363
|
-
if (_options != null && _options.getCallbacks() != null) {
|
|
3369
|
+
if (emitEvent && _options != null && _options.getCallbacks() != null) {
|
|
3364
3370
|
_options.getCallbacks().screenshotTaken(result);
|
|
3365
3371
|
}
|
|
3366
3372
|
callback.onSuccess(result);
|
|
@@ -3886,9 +3892,28 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
3886
3892
|
|
|
3887
3893
|
private void performToolbarCloseAction(String currentUrl) {
|
|
3888
3894
|
if (_options != null && "hide".equals(_options.getCloseAction())) {
|
|
3889
|
-
|
|
3890
|
-
|
|
3891
|
-
|
|
3895
|
+
if (toolbarHideInProgress) {
|
|
3896
|
+
return;
|
|
3897
|
+
}
|
|
3898
|
+
toolbarHideInProgress = true;
|
|
3899
|
+
if (_options.getScreenshotOnHide()) {
|
|
3900
|
+
takeScreenshot(
|
|
3901
|
+
false,
|
|
3902
|
+
new ScreenshotResultCallback() {
|
|
3903
|
+
@Override
|
|
3904
|
+
public void onSuccess(JSObject screenshot) {
|
|
3905
|
+
hideAndEmit(currentUrl, screenshot);
|
|
3906
|
+
}
|
|
3907
|
+
|
|
3908
|
+
@Override
|
|
3909
|
+
public void onError(String message) {
|
|
3910
|
+
Log.e("InAppBrowser", "Failed to capture screenshot before hiding: " + message);
|
|
3911
|
+
hideAndEmit(currentUrl, null);
|
|
3912
|
+
}
|
|
3913
|
+
}
|
|
3914
|
+
);
|
|
3915
|
+
} else {
|
|
3916
|
+
hideAndEmit(currentUrl, null);
|
|
3892
3917
|
}
|
|
3893
3918
|
return;
|
|
3894
3919
|
}
|
|
@@ -3899,6 +3924,13 @@ public class WebViewDialog extends Dialog implements ProxyResponseRouting.ProxyR
|
|
|
3899
3924
|
}
|
|
3900
3925
|
}
|
|
3901
3926
|
|
|
3927
|
+
private void hideAndEmit(String currentUrl, JSObject screenshot) {
|
|
3928
|
+
setHidden(true);
|
|
3929
|
+
if (_options != null && _options.getCallbacks() != null) {
|
|
3930
|
+
_options.getCallbacks().hideEvent(currentUrl, screenshot);
|
|
3931
|
+
}
|
|
3932
|
+
}
|
|
3933
|
+
|
|
3902
3934
|
private void applyTitleTextOptions(TextView titleText) {
|
|
3903
3935
|
if (titleText == null || _options == null) {
|
|
3904
3936
|
return;
|
package/dist/docs.json
CHANGED
|
@@ -457,7 +457,7 @@
|
|
|
457
457
|
},
|
|
458
458
|
{
|
|
459
459
|
"name": "addListener",
|
|
460
|
-
"signature": "(eventName: 'hideEvent', listenerFunc:
|
|
460
|
+
"signature": "(eventName: 'hideEvent', listenerFunc: HideListener) => Promise<PluginListenerHandle>",
|
|
461
461
|
"parameters": [
|
|
462
462
|
{
|
|
463
463
|
"name": "eventName",
|
|
@@ -467,7 +467,7 @@
|
|
|
467
467
|
{
|
|
468
468
|
"name": "listenerFunc",
|
|
469
469
|
"docs": "",
|
|
470
|
-
"type": "
|
|
470
|
+
"type": "HideListener"
|
|
471
471
|
}
|
|
472
472
|
],
|
|
473
473
|
"returns": "Promise<PluginListenerHandle>",
|
|
@@ -480,7 +480,7 @@
|
|
|
480
480
|
"docs": "Listen for webviews hidden by the toolbar close button when closeAction is CloseAction.HIDE.",
|
|
481
481
|
"complexTypes": [
|
|
482
482
|
"PluginListenerHandle",
|
|
483
|
-
"
|
|
483
|
+
"HideListener"
|
|
484
484
|
],
|
|
485
485
|
"slug": "addlistenerhideevent-"
|
|
486
486
|
},
|
|
@@ -1772,6 +1772,22 @@
|
|
|
1772
1772
|
],
|
|
1773
1773
|
"type": "CloseAction"
|
|
1774
1774
|
},
|
|
1775
|
+
{
|
|
1776
|
+
"name": "screenshotOnHide",
|
|
1777
|
+
"tags": [
|
|
1778
|
+
{
|
|
1779
|
+
"text": "false",
|
|
1780
|
+
"name": "default"
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"text": "8.7.10",
|
|
1784
|
+
"name": "since"
|
|
1785
|
+
}
|
|
1786
|
+
],
|
|
1787
|
+
"docs": "Captures the visible webview and includes it as `screenshot` in `hideEvent`\nbefore the toolbar close button hides the webview.\n\nOnly applies when `closeAction` is `CloseAction.HIDE`.",
|
|
1788
|
+
"complexTypes": [],
|
|
1789
|
+
"type": "boolean | undefined"
|
|
1790
|
+
},
|
|
1775
1791
|
{
|
|
1776
1792
|
"name": "closeModal",
|
|
1777
1793
|
"tags": [
|
|
@@ -2747,6 +2763,38 @@
|
|
|
2747
2763
|
}
|
|
2748
2764
|
]
|
|
2749
2765
|
},
|
|
2766
|
+
{
|
|
2767
|
+
"name": "HideEvent",
|
|
2768
|
+
"slug": "hideevent",
|
|
2769
|
+
"docs": "",
|
|
2770
|
+
"tags": [],
|
|
2771
|
+
"methods": [],
|
|
2772
|
+
"properties": [
|
|
2773
|
+
{
|
|
2774
|
+
"name": "id",
|
|
2775
|
+
"tags": [],
|
|
2776
|
+
"docs": "Webview instance id.",
|
|
2777
|
+
"complexTypes": [],
|
|
2778
|
+
"type": "string | undefined"
|
|
2779
|
+
},
|
|
2780
|
+
{
|
|
2781
|
+
"name": "url",
|
|
2782
|
+
"tags": [],
|
|
2783
|
+
"docs": "URL active when the webview was hidden.",
|
|
2784
|
+
"complexTypes": [],
|
|
2785
|
+
"type": "string"
|
|
2786
|
+
},
|
|
2787
|
+
{
|
|
2788
|
+
"name": "screenshot",
|
|
2789
|
+
"tags": [],
|
|
2790
|
+
"docs": "Screenshot captured immediately before the toolbar close button hides the webview.\nPresent only when `screenshotOnHide` is enabled and capture succeeds.",
|
|
2791
|
+
"complexTypes": [
|
|
2792
|
+
"ScreenshotResult"
|
|
2793
|
+
],
|
|
2794
|
+
"type": "ScreenshotResult"
|
|
2795
|
+
}
|
|
2796
|
+
]
|
|
2797
|
+
},
|
|
2750
2798
|
{
|
|
2751
2799
|
"name": "BtnEvent",
|
|
2752
2800
|
"slug": "btnevent",
|
|
@@ -3603,6 +3651,19 @@
|
|
|
3603
3651
|
}
|
|
3604
3652
|
]
|
|
3605
3653
|
},
|
|
3654
|
+
{
|
|
3655
|
+
"name": "HideListener",
|
|
3656
|
+
"slug": "hidelistener",
|
|
3657
|
+
"docs": "",
|
|
3658
|
+
"types": [
|
|
3659
|
+
{
|
|
3660
|
+
"text": "(state: HideEvent): void",
|
|
3661
|
+
"complexTypes": [
|
|
3662
|
+
"HideEvent"
|
|
3663
|
+
]
|
|
3664
|
+
}
|
|
3665
|
+
]
|
|
3666
|
+
},
|
|
3606
3667
|
{
|
|
3607
3668
|
"name": "ConfirmBtnListener",
|
|
3608
3669
|
"slug": "confirmbtnlistener",
|
|
@@ -553,6 +553,22 @@ export interface ScreenshotResult {
|
|
|
553
553
|
*/
|
|
554
554
|
height: number;
|
|
555
555
|
}
|
|
556
|
+
export interface HideEvent {
|
|
557
|
+
/**
|
|
558
|
+
* Webview instance id.
|
|
559
|
+
*/
|
|
560
|
+
id?: string;
|
|
561
|
+
/**
|
|
562
|
+
* URL active when the webview was hidden.
|
|
563
|
+
*/
|
|
564
|
+
url: string;
|
|
565
|
+
/**
|
|
566
|
+
* Screenshot captured immediately before the toolbar close button hides the webview.
|
|
567
|
+
* Present only when `screenshotOnHide` is enabled and capture succeeds.
|
|
568
|
+
*/
|
|
569
|
+
screenshot?: ScreenshotResult;
|
|
570
|
+
}
|
|
571
|
+
export type HideListener = (state: HideEvent) => void;
|
|
556
572
|
export interface CloseWebviewOptions {
|
|
557
573
|
/**
|
|
558
574
|
* Target webview id to close. If omitted, closes the active webview.
|
|
@@ -859,6 +875,16 @@ export interface OpenWebViewOptions {
|
|
|
859
875
|
* closeAction: CloseAction.HIDE
|
|
860
876
|
*/
|
|
861
877
|
closeAction?: CloseAction;
|
|
878
|
+
/**
|
|
879
|
+
* Captures the visible webview and includes it as `screenshot` in `hideEvent`
|
|
880
|
+
* before the toolbar close button hides the webview.
|
|
881
|
+
*
|
|
882
|
+
* Only applies when `closeAction` is `CloseAction.HIDE`.
|
|
883
|
+
*
|
|
884
|
+
* @default false
|
|
885
|
+
* @since 8.7.10
|
|
886
|
+
*/
|
|
887
|
+
screenshotOnHide?: boolean;
|
|
862
888
|
/**
|
|
863
889
|
* CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.
|
|
864
890
|
* @since 1.1.0
|
|
@@ -1447,7 +1473,7 @@ export interface InAppBrowserPlugin {
|
|
|
1447
1473
|
*
|
|
1448
1474
|
* @since 8.7.7
|
|
1449
1475
|
*/
|
|
1450
|
-
addListener(eventName: 'hideEvent', listenerFunc:
|
|
1476
|
+
addListener(eventName: 'hideEvent', listenerFunc: HideListener): Promise<PluginListenerHandle>;
|
|
1451
1477
|
/**
|
|
1452
1478
|
* Will be triggered when user clicks on confirm button when disclaimer is required,
|
|
1453
1479
|
* works with openWebView shareDisclaimer and closeModal
|
|
@@ -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 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 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 * 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 * 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 * preventDeeplink: if true, the deeplink will not be opened, if false the deeplink will be opened when clicked on the link. on IOS each schema need to be added to info.plist file under LSApplicationQueriesSchemes when false to make it work.\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 HTTPS links whose host matches any entry in this list\n * will attempt to open via the corresponding native application.\n * - If the app is not installed or the system cannot handle the link, the URL\n * will continue loading inside the in-app browser.\n * - Matching is host-based (case-insensitive), ignoring the \"www.\" prefix.\n * - When `preventDeeplink` is enabled, all external handling is blocked regardless of this list.\n *\n * @example\n * ```ts\n * [\"https://example.com\", \"https://subdomain.app.io\"]\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 pixels.\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 pixels.\n * If not set, webview will be fullscreen height.\n * @default undefined (fullscreen)\n * @example\n * height: 600\n */\n height?: number;\n\n /**\n * X position of the webview in pixels from the left edge.\n * Only effective when width is set.\n * @default 0\n * @example\n * x: 50\n */\n x?: number;\n\n /**\n * Y position of the webview in pixels from the top edge.\n * Only effective when 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 * When `id` is omitted, targets the active webview.\n */\n bringToFront(options?: { id?: string }): 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 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: UrlChangeListener): 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 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 * For web, you should have the code in the redirected page to use a broadcast channel to send the redirected url to the app\n * Something like:\n * ```html\n * <html>\n * <head></head>\n * <body>\n * <script>\n * const searchParams = new URLSearchParams(location.search)\n * if (searchParams.has(\"code\")) {\n * new BroadcastChannel(\"my-channel-name\").postMessage(location.href);\n * window.close();\n * }\n * </script>\n * </body>\n * </html>\n * ```\n * For mobile, you should have a redirect uri that opens the app, something like: `myapp://oauth_callback/`\n * And make sure to register it in the app's info.plist:\n * ```xml\n * <key>CFBundleURLTypes</key>\n * <array>\n * <dict>\n * <key>CFBundleURLSchemes</key>\n * <array>\n * <string>myapp</string>\n * </array>\n * </dict>\n * </array>\n * ```\n * And in the AndroidManifest.xml file:\n * ```xml\n * <activity>\n * <intent-filter>\n * <action android:name=\"android.intent.action.VIEW\" />\n * <category android:name=\"android.intent.category.DEFAULT\" />\n * <category android:name=\"android.intent.category.BROWSABLE\" />\n * <data android:host=\"oauth_callback\" android:scheme=\"myapp\" />\n * </intent-filter>\n * </activity>\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 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 * 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 * @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 * preventDeeplink: if true, the deeplink will not be opened, if false the deeplink will be opened when clicked on the link. on IOS each schema need to be added to info.plist file under LSApplicationQueriesSchemes when false to make it work.\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 HTTPS links whose host matches any entry in this list\n * will attempt to open via the corresponding native application.\n * - If the app is not installed or the system cannot handle the link, the URL\n * will continue loading inside the in-app browser.\n * - Matching is host-based (case-insensitive), ignoring the \"www.\" prefix.\n * - When `preventDeeplink` is enabled, all external handling is blocked regardless of this list.\n *\n * @example\n * ```ts\n * [\"https://example.com\", \"https://subdomain.app.io\"]\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 pixels.\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 pixels.\n * If not set, webview will be fullscreen height.\n * @default undefined (fullscreen)\n * @example\n * height: 600\n */\n height?: number;\n\n /**\n * X position of the webview in pixels from the left edge.\n * Only effective when width is set.\n * @default 0\n * @example\n * x: 50\n */\n x?: number;\n\n /**\n * Y position of the webview in pixels from the top edge.\n * Only effective when 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 * When `id` is omitted, targets the active webview.\n */\n bringToFront(options?: { id?: string }): 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 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 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 * For web, you should have the code in the redirected page to use a broadcast channel to send the redirected url to the app\n * Something like:\n * ```html\n * <html>\n * <head></head>\n * <body>\n * <script>\n * const searchParams = new URLSearchParams(location.search)\n * if (searchParams.has(\"code\")) {\n * new BroadcastChannel(\"my-channel-name\").postMessage(location.href);\n * window.close();\n * }\n * </script>\n * </body>\n * </html>\n * ```\n * For mobile, you should have a redirect uri that opens the app, something like: `myapp://oauth_callback/`\n * And make sure to register it in the app's info.plist:\n * ```xml\n * <key>CFBundleURLTypes</key>\n * <array>\n * <dict>\n * <key>CFBundleURLSchemes</key>\n * <array>\n * <string>myapp</string>\n * </array>\n * </dict>\n * </array>\n * ```\n * And in the AndroidManifest.xml file:\n * ```xml\n * <activity>\n * <intent-filter>\n * <action android:name=\"android.intent.action.VIEW\" />\n * <category android:name=\"android.intent.category.DEFAULT\" />\n * <category android:name=\"android.intent.category.BROWSABLE\" />\n * <data android:host=\"oauth_callback\" android:scheme=\"myapp\" />\n * </intent-filter>\n * </activity>\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"]}
|
|
@@ -98,7 +98,7 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
|
|
|
98
98
|
case aware = "AWARE"
|
|
99
99
|
case fakeVisible = "FAKE_VISIBLE"
|
|
100
100
|
}
|
|
101
|
-
private let pluginVersion: String = "8.
|
|
101
|
+
private let pluginVersion: String = "8.9.0"
|
|
102
102
|
public let identifier = "CapgoInAppBrowserPlugin"
|
|
103
103
|
public let jsName = "CapgoInAppBrowser"
|
|
104
104
|
public let pluginMethods: [CAPPluginMethod] = [
|
|
@@ -687,14 +687,20 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
|
|
|
687
687
|
self.navigationWebViewController = nil
|
|
688
688
|
}
|
|
689
689
|
|
|
690
|
-
func handleWebViewDidHide(id: String, url: String) {
|
|
690
|
+
func handleWebViewDidHide(id: String, url: String, screenshot: [String: Any]? = nil) {
|
|
691
|
+
var payload: [String: Any] = ["url": url]
|
|
692
|
+
if let screenshot {
|
|
693
|
+
payload["screenshot"] = screenshot
|
|
694
|
+
}
|
|
695
|
+
|
|
691
696
|
if !id.isEmpty {
|
|
692
|
-
|
|
697
|
+
payload["id"] = id
|
|
698
|
+
self.notifyListeners("hideEvent", data: payload)
|
|
693
699
|
self.setHiddenState(true, targetId: id, call: nil)
|
|
694
700
|
return
|
|
695
701
|
}
|
|
696
702
|
|
|
697
|
-
self.notifyListeners("hideEvent", data:
|
|
703
|
+
self.notifyListeners("hideEvent", data: payload)
|
|
698
704
|
self.setHiddenState(true, targetId: activeWebViewId, call: nil)
|
|
699
705
|
}
|
|
700
706
|
|
|
@@ -992,6 +998,7 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
|
|
|
992
998
|
let hiddenPopupWindow = call.getBool("hiddenPopupWindow", false)
|
|
993
999
|
let allowWebViewJsVisibilityControl = self.getConfig().getBoolean("allowWebViewJsVisibilityControl", false)
|
|
994
1000
|
let allowScreenshotsFromWebPage = call.getBool("allowScreenshotsFromWebPage", false)
|
|
1001
|
+
let screenshotOnHide = call.getBool("screenshotOnHide", false)
|
|
995
1002
|
let captureConsoleLogs = call.getBool("captureConsoleLogs", false)
|
|
996
1003
|
let handleDownloads = call.getBool("handleDownloads", false)
|
|
997
1004
|
let persistWebViewData = call.getBool("persistWebViewData", true)
|
|
@@ -1288,6 +1295,7 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
|
|
|
1288
1295
|
webViewController.capBrowserPlugin = self
|
|
1289
1296
|
webViewController.title = call.getString("title", "New Window")
|
|
1290
1297
|
webViewController.closeAction = closeAction
|
|
1298
|
+
webViewController.screenshotOnHide = screenshotOnHide
|
|
1291
1299
|
webViewController.titleFontFamily = titleFontFamily
|
|
1292
1300
|
webViewController.titleIcon = titleIcon
|
|
1293
1301
|
// Only set shareSubject if not already set for activity mode
|
|
@@ -1578,6 +1586,7 @@ public class CapgoInAppBrowserPlugin: CAPPlugin, CAPBridgedPlugin {
|
|
|
1578
1586
|
}
|
|
1579
1587
|
self.dismissNavigationControllerIfPresented(navigationController)
|
|
1580
1588
|
} else {
|
|
1589
|
+
webViewController.toolbarHideInProgress = false
|
|
1581
1590
|
if webView.superview !== webViewController.view {
|
|
1582
1591
|
self.attachWebViewToController(webViewController, webView: webView)
|
|
1583
1592
|
}
|
|
@@ -416,6 +416,8 @@ open class WKWebViewController: UIViewController, WKScriptMessageHandler {
|
|
|
416
416
|
var didpageInit = false
|
|
417
417
|
open var closeModal = false
|
|
418
418
|
open var closeAction = "close"
|
|
419
|
+
open var screenshotOnHide = false
|
|
420
|
+
var toolbarHideInProgress = false
|
|
419
421
|
open var titleFontFamily: String?
|
|
420
422
|
open var titleIcon: UIImage?
|
|
421
423
|
open var closeModalTitle = ""
|
|
@@ -1648,7 +1650,7 @@ open class WKWebViewController: UIViewController, WKScriptMessageHandler {
|
|
|
1648
1650
|
}
|
|
1649
1651
|
}
|
|
1650
1652
|
|
|
1651
|
-
func takeScreenshot(completion: @escaping (Result<[String: Any], Error>) -> Void) {
|
|
1653
|
+
func takeScreenshot(emitEvent: Bool = true, completion: @escaping (Result<[String: Any], Error>) -> Void) {
|
|
1652
1654
|
DispatchQueue.main.async {
|
|
1653
1655
|
guard let webView = self.webView else {
|
|
1654
1656
|
completion(.failure(NSError(domain: "InAppBrowser", code: 1, userInfo: [NSLocalizedDescriptionKey: "WebView is not initialized"])))
|
|
@@ -1686,7 +1688,9 @@ open class WKWebViewController: UIViewController, WKScriptMessageHandler {
|
|
|
1686
1688
|
"width": Int(image.size.width * image.scale),
|
|
1687
1689
|
"height": Int(image.size.height * image.scale)
|
|
1688
1690
|
]
|
|
1689
|
-
|
|
1691
|
+
if emitEvent {
|
|
1692
|
+
self.emit("screenshotTaken", data: result)
|
|
1693
|
+
}
|
|
1690
1694
|
completion(.success(result))
|
|
1691
1695
|
}
|
|
1692
1696
|
}
|
|
@@ -2216,6 +2220,7 @@ open class WKWebViewController: UIViewController, WKScriptMessageHandler {
|
|
|
2216
2220
|
self.enableGooglePaySupport = parent.enableGooglePaySupport
|
|
2217
2221
|
self.preventDeeplink = parent.preventDeeplink
|
|
2218
2222
|
self.closeAction = parent.closeAction
|
|
2223
|
+
self.screenshotOnHide = parent.screenshotOnHide
|
|
2219
2224
|
self.titleFontFamily = parent.titleFontFamily
|
|
2220
2225
|
self.titleIcon = parent.titleIcon
|
|
2221
2226
|
self.openBlankTargetInWebView = parent.openBlankTargetInWebView
|
|
@@ -3043,7 +3048,23 @@ fileprivate extension WKWebViewController {
|
|
|
3043
3048
|
if canDismiss {
|
|
3044
3049
|
let currentUrl = webView?.url?.absoluteString ?? ""
|
|
3045
3050
|
if closeAction == "hide" {
|
|
3046
|
-
|
|
3051
|
+
if toolbarHideInProgress {
|
|
3052
|
+
return
|
|
3053
|
+
}
|
|
3054
|
+
toolbarHideInProgress = true
|
|
3055
|
+
if screenshotOnHide {
|
|
3056
|
+
takeScreenshot(emitEvent: false) { result in
|
|
3057
|
+
switch result {
|
|
3058
|
+
case .success(let screenshot):
|
|
3059
|
+
self.capBrowserPlugin?.handleWebViewDidHide(id: self.instanceId, url: currentUrl, screenshot: screenshot)
|
|
3060
|
+
case .failure(let error):
|
|
3061
|
+
print("[InAppBrowser] Failed to capture screenshot before hiding: \(error.localizedDescription)")
|
|
3062
|
+
self.capBrowserPlugin?.handleWebViewDidHide(id: self.instanceId, url: currentUrl)
|
|
3063
|
+
}
|
|
3064
|
+
}
|
|
3065
|
+
} else {
|
|
3066
|
+
self.capBrowserPlugin?.handleWebViewDidHide(id: instanceId, url: currentUrl)
|
|
3067
|
+
}
|
|
3047
3068
|
return
|
|
3048
3069
|
}
|
|
3049
3070
|
cleanupWebView()
|