开始使用

复制一个包含安装步骤和本插件的完整Markdown指南的设置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/inappbrowser`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/inappbrowser/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

bun add @capgo/inappbrowser
bunx cap sync

导入

import { InAppBrowser } from '@capgo/inappbrowser';

API概述

`goBack`

如果可能，浏览器历史记录中向后导航

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.goBack();

`open`

在新窗口全屏幕中打开 URL，Android 中使用 Chrome 自定义标签，iOS 中使用 SFSafariViewController

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.open({} as OpenOptions);

`clearCookies`

清除URL的cookies 当 id 不填写时，适用于所有打开的网页视图。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.clearCookies({} as ClearCookieOptions);

`clearAllCookies`

清除所有cookies 当 id 不填写时，适用于所有打开的网页视图。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.clearAllCookies();

`clearCache`

清除缓存当 id 不填写时，适用于所有打开的网页视图。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.clearCache();

`getCookies`

获取特定 URL 的 Cookies。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.getCookies({} as GetCookieOptions);

`close`

当省略时，关闭当前 webview。 id 复制到剪贴板

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.close();

`hide`

显示 webview。 id 复制到剪贴板

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.hide();

`show`

显示一个之前隐藏的网页视图。当 id 目标是活动的网页视图。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.show();

`openWebView`

在具有工具栏、摄像头访问、文件访问、监听事件、注入 JavaScript、双向通信等增强功能的新网页视图中打开 URL。

JavaScript 接口: 当您使用此方法打开一个网页视图时，会自动注入一个 JavaScript 接口，该接口提供：

window.mobileApp.close():从 JavaScript 中关闭网页视图
window.mobileApp.postMessage({detail: {message: "myMessage"}}):从网页视图向应用发送消息，详细对象是您希望发送到网页视图的数据
window.mobileApp.takeScreenshot() 当 allowScreenshotsFromWebPage 为 true 时

Promise 的时间顺序在不同平台上有所不同，当 isPresentAfterPageLoad 用于时，Android 会以 { id } 当对话框准备就绪时，iOS会等待 { id } 创建原生webview后立即

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.openWebView({} as OpenWebViewOptions);

`executeScript`

将JavaScript code 注入InAppBrowser窗口。当 id 省略时，在所有打开的webview中执行。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.executeScript({} as { code: string; id?: string });

`postMessage`

将事件发送到webview（内嵌浏览器）。在webview JavaScript中，使用 window.addEventListener('messageFromNative', listenerFunc). detail 是将要发送到webview的载荷。由于它跨越了Capacitor 桥，必须是可JSON序列化的。当 id 省略时，广播到所有打开的webview。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.postMessage({} as { detail: Record<string, any>; id?: string });

`takeScreenshot`

捕获当前webview视图区域的PNG截图。当 id 省略时，目标活动webview。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.takeScreenshot();

`setUrl`

设置webview的URL。当 id 省略时，目标活动webview。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.setUrl({} as { url: string; id?: string });

`handleProxyRequest`

内部方法由 addProxyHandler() 发送代理决策回原生。转发原始 phase 回复手动请求 proxyRequest 监听器。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.handleProxyRequest({} as {
    requestId: string;
    decision?: ProxyDecision | null;
    response?: ProxyResponse | null;
    webviewId?: string;
    phase?: 'outbound' | 'inbound';
  });

`reload`

重新加载当前网页。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.reload();

`updateDimensions`

更新 webview 的尺寸。允许在运行时更改 webview 的大小和位置。当 id 省略时，目标是活动的 webview。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.updateDimensions({} as DimensionOptions & { id?: string });

`setEnabledSafeTopMargin`

设置 webview 在运行时的启用安全顶部边距。当 id 省略时，目标是活动的 webview。在 Web 上，这个方法是一个空操作，并且不会改变布局。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.setEnabledSafeTopMargin({} as { enabled: boolean; id?: string });

`setEnabledSafeBottomMargin`

设置 WebView 的启用安全底部边距。 id 在 Web 中，这个方法是空操作，直接返回结果而不改变布局。

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.setEnabledSafeBottomMargin({} as { enabled: boolean; id?: string });

`openSecureWindow`

打开一个安全的窗口进行 OAuth2 认证。\n对于 web，应在重定向页面中包含 code，以通过广播通道将重定向 URL 发送到应用\n例如：

<html>
<head></head>
<body>
<script>
  const searchParams = new URLSearchParams(location.search)
  if (searchParams.has("code")) {
    new BroadcastChannel("my-channel-name").postMessage(location.href);
    window.close();
  }
</script>
</body>
</html>

对于移动端，您应该有一个可以打开应用的重定向 URI，例如： myapp://oauth_callback/ 并确保在 app 的 info.plist 中注册它：

<key>CFBundleURLTypes</key>
<array>
   <dict>
      <key>CFBundleURLSchemes</key>
      <array>
         <string>myapp</string>
      </array>
   </dict>
</array>

在 AndroidManifest.xml 文件中：

<activity>
   <intent-filter>
      <action android:name="android.intent.action.VIEW" />
      <category android:name="android.intent.category.DEFAULT" />
      <category android:name="android.intent.category.BROWSABLE" />
      <data android:host="oauth_callback" android:scheme="myapp" />
   </intent-filter>
</activity>

import { InAppBrowser } from '@capgo/inappbrowser';

await InAppBrowser.openSecureWindow({} as OpenSecureWindowOptions);

类型参考

`OpenOptions`

export interface OpenOptions {
  /**
   * Target URL to load.
   * @since 0.1.0
   */
  url: string;
  /**
   * if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.
   * @since 0.1.0
   */
  isPresentAfterPageLoad?: boolean;
  /**
   * if true the deeplink will not be opened, if false the deeplink will be opened when clicked on the link
   * @since 0.1.0
   */
  preventDeeplink?: boolean;

  // --- Chrome Custom Tab customization (Android only, ignored on iOS) ---

  /**
   * Toolbar background color in hex format (e.g., "#1A1A2E").
   * Applied to both light and dark color schemes.
   * Also sets the navigation bar color to match.
   * **Android only** — ignored on iOS.
   * @since 8.2.0
   */
  toolbarColor?: string;

  /**
   * Whether the URL bar should auto-hide when the user scrolls down.
   * The bar reappears on any upward scroll.
   * **Android only** — ignored on iOS.
   * @default false
   * @since 8.2.0
   */
  urlBarHidingEnabled?: boolean;

  /**
   * Show the page's HTML <title> in the toolbar instead of the raw URL.
   * The true URL is still visible when the user taps the title area.
   * **Android only** — ignored on iOS.
   * @default false
   * @since 8.2.0
   */
  showTitle?: boolean;

  /**
   * Replace the default "X" close icon with a back arrow.
   * Makes the Custom Tab feel like a native navigation push rather than a modal overlay.
   * **Android only** — ignored on iOS.
   * @default false
   * @since 8.2.0
   */
  showArrow?: boolean;

  /**
   * Remove the share action from the overflow menu.
   * **Android only** — ignored on iOS.
   * @default false
   * @since 8.2.0
   */
  disableShare?: boolean;

  /**
   * Hide the bookmark star icon in the overflow menu.
   * Uses an undocumented Chromium intent extra — may stop working on future Chrome updates.
   * **Android only** — ignored on iOS.
   * @default false
   * @since 8.2.0
   */
  disableBookmark?: boolean;

  /**
   * Hide the download icon in the overflow menu.
   * Uses an undocumented Chromium intent extra — may stop working on future Chrome updates.
   * **Android only** — ignored on iOS.
   * @default false
   * @since 8.2.0
   */
  disableDownload?: boolean;
}

`ClearCookieOptions`

export interface ClearCookieOptions {
  /**
   * Target webview id.
   * When omitted, applies to all open webviews.
   */
  id?: string;
  url: string;
}

`GetCookieOptions`

export interface GetCookieOptions {
  url: string;
  includeHttpOnly?: boolean;
}

`CloseWebviewOptions`

export interface CloseWebviewOptions {
  /**
   * Target webview id to close. If omitted, closes the active webview.
   */
  id?: string;
  /**
   * Whether the webview closing is animated or not, ios only
   * @default true
   */
  isAnimated?: boolean;
}

`OpenWebViewOptions`

export interface OpenWebViewOptions {
  /**
   * Target URL to load.
   * @since 0.1.0
   * @example "https://capgo.app"
   */
  url: string;
  /**
   * Headers to send with the request.
   * @since 0.1.0
   * @example
   * headers: {
   *   "Custom-Header": "test-value",
   *   "Authorization": "Bearer test-token"
   * }
   * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/
   */
  headers?: Headers;
  /**
   * Credentials to send with the request and all subsequent requests for the same host.
   * @since 6.1.0
   * @example
   * credentials: {
   *   username: "test-user",
   *   password: "test-pass"
   * }
   * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/
   */
  credentials?: Credentials;
  /**
   * HTTP method to use for the initial request.
   *
   * **Optional parameter - defaults to GET if not specified.**
   * Existing code that doesn't provide this parameter will continue to work unchanged with standard GET requests.
   *
   * When specified with 'POST', 'PUT', or 'PATCH' methods that support a body,
   * you can also provide a `body` parameter with the request payload.
   *
   * **Platform Notes:**
   * - iOS: Full support for all HTTP methods with headers
   * - Android: Custom headers may not be sent with POST/PUT/PATCH requests due to WebView limitations
   *
   * @since 8.2.0
   * @default "GET"
   * @example
   * method: "POST",
   * body: JSON.stringify({ token: "auth-token", data: "value" }),
   * headers: { "Content-Type": "application/json" }
   */
  method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | string;
  /**
   * HTTP body to send with the request when using POST, PUT, or other methods that support a body.
   * Should be a string (use JSON.stringify for JSON data).
   *
   * **Optional parameter - only used when `method` is specified and supports a request body.**
   * Omitting this parameter (or using GET method) results in standard behavior without a request body.
   *
   * @since 8.2.0
   * @example
   * method: "POST",
   * body: JSON.stringify({ username: "user", password: "pass" }),
   * headers: { "Content-Type": "application/json" }
   */
  body?: string;
  /**
   * materialPicker: if true, uses Material Design theme for date and time pickers on Android.
   * This improves the appearance of HTML date inputs to use modern Material Design UI instead of the old style pickers.
   * @since 7.4.1
   * @default false
   * @example
   * materialPicker: true
   * Test URL: https://show-picker.glitch.me/demo.html
   */
  materialPicker?: boolean;
  /**
   * JavaScript Interface:
   * The webview automatically injects a JavaScript interface providing:
   * - `window.mobileApp.close()`: Closes the webview from JavaScript
   * - `window.mobileApp.postMessage(obj)`: Sends a message to the app (listen via "messageFromWebview" event)
   * - `window.mobileApp.hide()` / `window.mobileApp.show()` when allowWebViewJsVisibilityControl is true in CapacitorConfig
   * - `window.mobileApp.takeScreenshot()` when `allowScreenshotsFromWebPage` is true
   *
   * @example
   * // In your webpage loaded in the webview:
   * document.getElementById("closeBtn").addEventListener("click", () => {
   *   window.mobileApp.close();
   * });
   *
   * // Send data to the app
   * window.mobileApp.postMessage({ action: "login", data: { user: "test" }});
   *
   * @since 6.10.0
   */
  jsInterface?: never; // This property doesn't exist, it's just for documentation
  /**
   * Allows page JavaScript to call `window.mobileApp.takeScreenshot()`.
   * Disabled by default so only the host app can trigger native screenshots through the plugin API.
   *
   * @default false
   * @since 8.4.0
   */
  allowScreenshotsFromWebPage?: boolean;
  /**
   * Emits `consoleMessage` events for JavaScript `console.*` output coming from the managed page.
   * Useful when the webview stays hidden and you still need page-level diagnostics.
   *
   * @default false
   * @since 8.6.0
   */
  captureConsoleLogs?: boolean;
  /**
   * Automatically handles downloads triggered inside the webview without requiring a custom JavaScript bridge.
   *
   * When enabled:
   * - Standard attachment responses are written to a temporary file.
   * - `blob:` downloads are also captured when the platform supports them.
   * - Previewable files reopen inside the in-app browser when possible.
   * - Other files are handed off to the native preview or viewer flow.
   * - `downloadCompleted` and `downloadFailed` events notify the host app about the saved file.
   *
   * @default false
   * @since 8.6.0
   */
  handleDownloads?: boolean;
  /**
   * Share options for the webview. When provided, shows a disclaimer dialog before sharing content.
   * This is useful for:
   * - Warning users about sharing sensitive information
   * - Getting user consent before sharing
   * - Explaining what will be shared
   * - Complying with privacy regulations
   *
   * Note: shareSubject is required when using shareDisclaimer
   * @since 0.1.0
   * @example
   * shareDisclaimer: {
   *   title: "Disclaimer",
   *   message: "This is a test disclaimer",
   *   confirmBtn: "Accept",
   *   cancelBtn: "Decline"
   * }
   * Test URL: https://capgo.app
   */
  shareDisclaimer?: DisclaimerOptions;
  /**
   * Toolbar type determines the appearance and behavior of the browser's toolbar
   * - "activity": Shows a simple toolbar with just a close button and share button
   * - "navigation": Shows a full navigation toolbar with back/forward buttons
   * - "blank": Shows no toolbar
   * - "": Default toolbar with close button
   * @since 0.1.0
   * @default ToolBarType.DEFAULT
   * @example
   * toolbarType: ToolBarType.ACTIVITY,
   * title: "Activity Toolbar Test"
   * Test URL: https://capgo.app
   */
  toolbarType?: ToolBarType;
  /**
   * Subject text for sharing. Required when using shareDisclaimer.
   * This text will be used as the subject line when sharing content.
   * @since 0.1.0
   * @example "Share this page"
   */
  shareSubject?: string;
  /**
   * Title of the browser
   * @since 0.1.0
   * @default "New Window"
   * @example "Camera Test"
   */
  title?: string;
  /**
   * Background color of the browser
   * @since 0.1.0
   * @default BackgroundColor.BLACK
   */
  backgroundColor?: BackgroundColor;
  /**
   * If true, enables native navigation gestures within the webview.
   * - Android: Native back button navigates within webview history
   * - iOS: Enables swipe left/right gestures for back/forward navigation
   * @default false (Android), true (iOS - enabled by default)
   * @example
   * activeNativeNavigationForWebview: true,
   * disableGoBackOnNativeApplication: true
   * Test URL: https://capgo.app
   */
  activeNativeNavigationForWebview?: boolean;
  /**
   * Disable the possibility to go back on native application,
   * useful to force user to stay on the webview, Android only
   * @default false
   * @example
   * disableGoBackOnNativeApplication: true
   * Test URL: https://capgo.app
   */
  disableGoBackOnNativeApplication?: boolean;
  /**
   * Open url in a new window fullscreen
   * isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.
   * Promise timing: on Android, `openWebView()` resolves with the webview id when the webview is ready to be controlled
   * (immediately for hidden/immediate presentation, after the first page load when `isPresentAfterPageLoad` is `true`).
   * On iOS, the promise resolves with the id as soon as the native webview is created, even if presentation is deferred.
   * @since 0.1.0
   * @default false
   * @example
   * isPresentAfterPageLoad: true,
   * preShowScript: "await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });"
   * Test URL: https://capgo.app
   */
  isPresentAfterPageLoad?: boolean;
  /**
   * Whether the website in the webview is inspectable or not, ios only
   * @default false
   */
  isInspectable?: boolean;
  /**
   * Whether the webview opening is animated or not, ios only
   * @default true
   */
  isAnimated?: boolean;
  /**
   * Shows a reload button that reloads the web page
   * @since 1.0.15
   * @default false
   * @example
   * showReloadButton: true
   * Test URL: https://capgo.app
   */
  showReloadButton?: boolean;
  /**
   * CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.
   * @since 1.1.0
   * @default false
   * @example
   * closeModal: true,
   * closeModalTitle: "Close Window",
   * closeModalDescription: "Are you sure you want to close?",
   * closeModalOk: "Yes, close",
   * closeModalCancel: "No, stay"
   * Test URL: https://capgo.app
   */
  closeModal?: boolean;
  /**
   * CloseModalTitle: title of the confirm when user clicks on close button
   * @since 1.1.0
   * @default "Close"
   */
  closeModalTitle?: string;
  /**
   * CloseModalDescription: description of the confirm when user clicks on close button
   * @since 1.1.0
   * @default "Are you sure you want to close this window?"
   */
  closeModalDescription?: string;
  /**
   * CloseModalOk: text of the confirm button when user clicks on close button
   * @since 1.1.0
   * @default "Close"
   */
  closeModalOk?: string;
  /**
   * CloseModalCancel: text of the cancel button when user clicks on close button
   * @since 1.1.0
   * @default "Cancel"
   */
  closeModalCancel?: string;
  /**
   * closeModalURLPattern: a regex pattern to match against the current URL when the close button is pressed.
   * When provided along with closeModal: true, the close confirmation modal is only shown if the current URL matches this pattern.
   * If the current URL does not match, the browser closes immediately without showing the modal.
   * Requires closeModal to be true.
   * @since 7.2.0
   * @example
   * closeModal: true,
   * closeModalURLPattern: ".*checkout.*"
   */
  closeModalURLPattern?: string;
  /**
   * visibleTitle: if true the website title would be shown else shown empty
   * @since 1.2.5
   * @default true
   */
  visibleTitle?: boolean;
  /**
   * toolbarColor: color of the toolbar in hex format
   * @since 1.2.5
   * @default "#ffffff"
   * @example
   * toolbarColor: "#FF5733"
   * Test URL: https://capgo.app
   */
  toolbarColor?: string;
  /**
   * toolbarTextColor: color of the buttons and title in the toolbar in hex format
   * When set, it overrides the automatic light/dark mode detection for text color
   * @since 6.10.0
   * @default calculated based on toolbarColor brightness
   * @example
   * toolbarTextColor: "#FFFFFF"
   * Test URL: https://capgo.app
   */
  toolbarTextColor?: string;
  /**
   * showArrow: if true an arrow would be shown instead of cross for closing the window
   * @since 1.2.5
   * @default false
   * @example
   * showArrow: true
   * Test URL: https://capgo.app
   */
  showArrow?: boolean;
  /**
   * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.
   * @since 6.1.0
   * @default false
   */
  ignoreUntrustedSSLError?: boolean;
  /**
   * preShowScript: if isPresentAfterPageLoad is true and this variable is set the plugin will inject a script before showing the browser.
   * This script will be run in an async context. The plugin will wait for the script to finish (max 10 seconds)
   * @since 6.6.0
   * @example
   * preShowScript: "await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });"
   * Test URL: https://capgo.app
   */
  preShowScript?: string;
  /**
   * preShowScriptInjectionTime: controls when the preShowScript is injected.
   * - "documentStart": injects before any page JavaScript runs (good for polyfills like Firebase)
   * - "pageLoad": injects after page load (default, original behavior)
   * @since 7.26.0
   * @default "pageLoad"
   * @example
   * preShowScriptInjectionTime: "documentStart"
   */
  preShowScriptInjectionTime?: 'documentStart' | 'pageLoad';
  /**
   * Proxy interception mode.
   *
   * - `true`: legacy blanket mode, delegates all HTTP/HTTPS requests to JavaScript.
   * - `string`: Android-only regex mode kept for backward compatibility.
   *
   * Prefer `outboundProxyRules` and `inboundProxyRules` for native-first matching.
   *
   * @since 6.9.0
   */
  proxyRequests?: boolean | string;
  /**
   * Native-first outbound proxy rules.
   *
   * @since 8.6.0
   */
  outboundProxyRules?: NativeProxyRule[];
  /**
   * Native-first inbound proxy rules.
   *
   * @since 8.6.0
   */
  inboundProxyRules?: NativeProxyRule[];
  /**
   * buttonNearDone allows for a creation of a custom button near the done/close button.
   * The button is only shown when toolbarType is not "activity", "navigation", or "blank".
   *
   * For Android:
   * - iconType must be "asset"
   * - icon path should be in the public folder (e.g. "monkey.svg")
   * - width and height are optional, defaults to 48dp
   * - button is positioned at the end of toolbar with 8dp margin
   *
   * For iOS:
   * - iconType can be "sf-symbol" or "asset"
   * - for sf-symbol, icon should be the symbol name
   * - for asset, icon should be the asset name
   * @since 6.7.0
   * @example
   * buttonNearDone: {
   *   ios: {
   *     iconType: "sf-symbol",
   *     icon: "star.fill"
   *   },
   *   android: {
   *     iconType: "asset",
   *     icon: "public/monkey.svg",
   *     width: 24,
   *     height: 24
   *   }
   * }
   * Test URL: https://capgo.app
   */
  buttonNearDone?: {
    ios: {
      iconType: 'sf-symbol' | 'asset';
      icon: string;
    };
    android: {
      iconType: 'asset' | 'vector';
      icon: string;
      width?: number;
      height?: number;
    };
  };
  /**
   * Shows a native screenshot button near the done/close button.
   * The button is hidden by default and captures the current viewport when tapped.
   * This option uses the same toolbar slot as `buttonNearDone` and is therefore incompatible with it.
   * The button is only shown when toolbarType is not "activity", "navigation", or "blank".
   *
   * @default false
   * @since 8.4.0
   */
  showScreenshotButton?: boolean;
  /**
   * textZoom: sets the text zoom of the page in percent.
   * Allows users to increase or decrease the text size for better readability.
   * @since 7.6.0
   * @default 100
   * @example
   * textZoom: 120
   * Test URL: https://capgo.app
   */
  textZoom?: number;
  /**
   * enableZoom: enables pinch-to-zoom gestures in the Android WebView.
   * When true, built-in zoom controls are enabled and the zoom buttons are hidden.
   * **Android only** — ignored on iOS where zoom is enabled by default.
   * @since 8.5.0
   * @default false
   * @example
   * enableZoom: true
   */
  enableZoom?: boolean;
  /**
   * 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.
   * @since 0.1.0
   * @default false
   * @example
   * preventDeeplink: true
   * Test URL: https://aasa-tester.capgo.app/
   */
  preventDeeplink?: boolean;

  /**
   * 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.
   * 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.
   * Custom schemes such as `tel:` and `mailto:` and authorized app links still prefer their native handlers unless `preventDeeplink` is enabled.
   *
   * @since 8.5.6
   * @default false
   * @example
   * openBlankTargetInWebView: true
   */
  openBlankTargetInWebView?: boolean;

  /**
   * List of base URLs whose hosts are treated as authorized App Links (Android) and Universal Links (iOS).
   *
   * - On both platforms, only HTTPS links whose host matches any entry in this list
   *   will attempt to open via the corresponding native application.
   * - If the app is not installed or the system cannot handle the link, the URL
   *   will continue loading inside the in-app browser.
   * - Matching is host-based (case-insensitive), ignoring the "www." prefix.
   * - When `preventDeeplink` is enabled, all external handling is blocked regardless of this list.
   *
   * @example
   * ```ts
   * ["https://example.com", "https://subdomain.app.io"]
   * ```
   *
   * @since 7.12.0
   * @default []
   */
  authorizedAppLinks?: string[];

  /**
   * If true, the webView will not take the full height and will have a 20px margin at the bottom.
   * This creates a safe margin area outside the browser view.
   * @since 7.13.0
   * @default false
   * @example
   * enabledSafeBottomMargin: true
   */
  enabledSafeBottomMargin?: boolean;

  /**
   * If false, the webView will extend behind the status bar for true full-screen immersive content.
   * When true (default), respects the safe area at the top of the screen.
   * Works independently of toolbarType - use for full-screen video players, games, or immersive web apps.
   * @since 8.2.0
   * @default true
   * @example
   * enabledSafeTopMargin: false  // Full screen, extends behind status bar
   */
  enabledSafeTopMargin?: boolean;

  /**
   * When true, applies the system status bar inset as the WebView top margin on Android.
   * Keeps the legacy 0px margin by default for apps that handle padding themselves.
   * @default false
   * @example
   * useTopInset: true
   */
  useTopInset?: boolean;

  /**
   * enableGooglePaySupport: if true, enables support for Google Pay popups and Payment Request API.
   * This fixes OR_BIBED_15 errors by allowing popup windows and configuring Cross-Origin-Opener-Policy.
   * Only enable this if you need Google Pay functionality as it allows popup windows.
   *
   * When enabled:
   * - Allows popup windows for Google Pay authentication
   * - Sets proper CORS headers for Payment Request API
   * - Enables multiple window support in WebView
   * - Configures secure context for payment processing
   *
   * @since 7.13.0
   * @default false
   * @example
   * enableGooglePaySupport: true
   * Test URL: https://developers.google.com/pay/api/web/guides/tutorial
   */
  enableGooglePaySupport?: boolean;

  /**
   * Opens popup windows created by the page in hidden mode.
   * Hidden popup windows can still be controlled with `executeScript`, `postMessage`, `show`, and `close`.
   * Listen to `popupWindowOpened` to capture the popup id, then call `show({ id })` only if you want to reveal it.
   *
   * @default false
   * @since 8.6.0
   * @example
   * hiddenPopupWindow: true
   */
  hiddenPopupWindow?: boolean;

  /**
   * blockedHosts: List of host patterns that should be blocked from loading in the InAppBrowser's internal navigations.
   * Any request inside WebView to a URL with a host matching any of these patterns will be blocked.
   * Supports wildcard patterns like:
   * - "*.example.com" to block all subdomains
   * - "www.example.*" to block wildcard domain extensions
   *
   * @since 7.17.0
   * @default []
   * @example
   * blockedHosts: ["*.tracking.com", "ads.example.com"]
   */
  blockedHosts?: string[];

  /**
   * Width of the webview in pixels.
   * If not set, webview will be fullscreen width.
   * @default undefined (fullscreen)
   * @example
   * width: 400
   */
  width?: number;

  /**
   * Height of the webview in pixels.
   * If not set, webview will be fullscreen height.
   * @default undefined (fullscreen)
   * @example
   * height: 600
   */
  height?: number;

  /**
   * X position of the webview in pixels from the left edge.
   * Only effective when width is set.
   * @default 0
   * @example
   * x: 50
   */
  x?: number;

  /**
   * Y position of the webview in pixels from the top edge.
   * Only effective when height is set.
   * @default 0
   * @example
   * y: 100
   */
  y?: number;

  /**
   * Disables the bounce (overscroll) effect on iOS WebView.
   * When enabled, prevents the rubber band scrolling effect when users scroll beyond content boundaries.
   * This is useful for:
   * - Creating a more native, app-like experience
   * - Preventing accidental overscroll states
   * - Avoiding issues when keyboard opens/closes
   *
   * Note: This option only affects iOS. Android does not have this bounce effect by default.
   *
   * @since 8.0.2
   * @default false
   * @example
   * disableOverscroll: true
   */
  disableOverscroll?: boolean;

  /**
   * Opens the webview in hidden mode (not visible to user but fully functional).
   * When hidden, the webview loads and executes JavaScript but is not displayed.
   * All control methods (executeScript, postMessage, setUrl, etc.) work while hidden.
   * Use close() to clean up the hidden webview when done.
   *
   * @since 8.0.7
   * @default false
   * @example
   * hidden: true
   */
  hidden?: boolean;

  /**
   * Controls how a hidden webview reports its visibility and size.
   * - AWARE: webview is aware it's hidden (dimensions may be zero).
   * - FAKE_VISIBLE: webview is hidden but reports fullscreen dimensions (uses alpha=0 to remain invisible).
   *
   * @default InvisibilityMode.AWARE
   * @example
   * invisibilityMode: InvisibilityMode.FAKE_VISIBLE
   */
  invisibilityMode?: InvisibilityMode;
}

`ScreenshotResult`

export interface ScreenshotResult {
  /**
   * Image format used for the screenshot.
   */
  format: '.png';
  /**
   * MIME type of the generated screenshot.
   */
  mimeType: 'image/.png';
  /**
   * Base64-encoded screenshot payload without the data URL prefix.
   */
  base64: string;
  /**
   * Data URL for direct use in HTML img tags or uploads.
   */
  dataUrl: string;
  /**
   * Screenshot width in pixels.
   */
  width: number;
  /**
   * Screenshot height in pixels.
   */
  height: number;
}

`UrlChangeListener`

export type UrlChangeListener = (state: UrlEvent) => void;

`ButtonNearListener`

export type ButtonNearListener = (state: object) => void;

`ConfirmBtnListener`

export type ConfirmBtnListener = (state: BtnEvent) => void;

`DownloadCompletedEvent`

下载完成事件后发出

export interface DownloadCompletedEvent {
  /**
   * Source webview instance id.
   */
  id?: string;
  /**
   * Original URL that triggered the download when available.
   */
  sourceUrl?: string;
  /**
   * Saved filename.
   */
  fileName: string;
  /**
   * Resolved MIME type when available.
   */
  mimeType?: string;
  /**
   * Absolute native filesystem path to the saved file.
   */
  path: string;
  /**
   * `file://` URL pointing at the saved file.
   */
  localUrl: string;
  /**
   * How native handled the downloaded file after saving it.
   */
  handledBy: DownloadHandledBy;
}

`DownloadFailedEvent`

当管理下载处理失败时发射的事件。

export interface DownloadFailedEvent {
  /**
   * Source webview instance id.
   */
  id?: string;
  /**
   * Original URL that triggered the download when available.
   */
  sourceUrl?: string;
  /**
   * Intended filename when known.
   */
  fileName?: string;
  /**
   * Resolved MIME type when available.
   */
  mimeType?: string;
  /**
   * Native error message.
   */
  error: string;
}

`PopupWindowEvent`

当一个网页打开弹出窗口/新窗口时发射的事件。

export interface PopupWindowEvent {
  /**
   * Popup webview instance id.
   */
  id: string;
  /**
   * Parent webview instance id.
   */
  parentId?: string;
  /**
   * Requested popup URL when available.
   */
  url?: string;
  /**
   * Whether the popup was presented immediately.
   */
  visible: boolean;
}

真实数据来源

本页是由插件的 src/definitions.ts当公共API上游发生变化时，请重新运行同步。