跳过主要内容
返回插件
@capgo/capacitor-inappbrowser 重命名 从 @capgo/inappbrowser 重命名为 @capgo/capacitor-inappbrowser。
教程
@capgo/capacitor-inappbrowser

本地浏览器

使用本地UI层次结构、私有会话、下载、代理和消息功能打开管理的本地Web视图

指南

In App 浏览器教程

在设备上测试

下载 Capgo 应用程序,然后扫描二维码 code。

In App Browser插件预览二维码 code

使用 @capgo/capacitor-inappbrowser

@capgo/capacitor-inappbrowser 打开一个来自 Capacitor 应用的外部网页。使用 open() 适用于平台浏览器表面,或 openWebView() 当您的应用需要一个受管理的本机 WebView,具有自定义大小、工具栏、消息、脚本、下载、代理、弹出控制、私有存储或 Ionic UI 层叠在页面上时。

安装

npm install @capgo/capacitor-inappbrowser
npx cap sync

此插件暴露的内容

  • 使用系统浏览器流程,带有 Android 上的 Chrome 自定义标签页 SFSafariViewController 在 iOS 上。
  • 可以调整大小、隐藏、显示、在 Capacitor 应用程序后面移动并将其带回前面的管理 WebViews。
  • 点击、触摸和滚动的转发与 dispatchInputEvent() 当应用 UI 位于浏览器之上时。
  • 部分屏幕浏览器,其中 Android 和 iOS 上的 Capacitor 应用程序的外部点击将传递给浏览器。
  • Cookie、缓存和完整的浏览数据清理与 persistWebViewData, clearCookies, clearAllCookies, clearCache,和 clearAllBrowsingData.
  • 应用与页面的通信与 postMessage(),页面与应用的通信与 window.mobileApp.postMessage(...),和脚本注入 executeScript().
  • 下载处理、原生代理规则、弹出控制、Google Pay 支持 _blank 链接处理和隐藏的预加载浏览器实例。

常见用例

将 App UI 置于一个活跃的浏览器上

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

const { id } = await InAppBrowser.openWebView({
  url: 'https://example.com/checkout',
  toBack: true,
  transparentBackground: true,
});

await InAppBrowser.dispatchInputEvent({
  id,
  type: 'click',
  x: 160,
  y: 420,
});

await InAppBrowser.bringToFront({ id });

适用于以下场景:

保持 App 点击区域在浏览器弹窗周围可点击

const { id } = await InAppBrowser.openWebView({
  url: 'https://example.com/offers',
  height: window.innerHeight - 200,
  y: 0,
});

await InAppBrowser.updateDimensions({ id, height: window.innerHeight });

一个自定义大小的浏览器仅捕获其框架内的触摸。剩余可见的应用区域在 Android 和 iOS 上保持可点击。

避免持久的 Web 会话

const { id } = await InAppBrowser.openWebView({
  url: 'https://example.com/login',
  persistWebViewData: false,
});

await InAppBrowser.clearAllBrowsingData();
await InAppBrowser.close({ id });

适用于以下场景:

预加载和交换多个 WebViews

const first = await InAppBrowser.openWebView({ url: 'https://example.com/a', hidden: true });
const second = await InAppBrowser.openWebView({ url: 'https://example.com/b', hidden: true });

await InAppBrowser.show({ id: first.id });
await InAppBrowser.hide({ id: first.id });
await InAppBrowser.show({ id: second.id });

隐藏的实例保持其状态可用,同时避免阻塞应用触摸的原生弹窗。

嵌入一个高级 Web 应用

const { id } = await InAppBrowser.openWebView({
  url: 'https://example.com/portal',
  handleDownloads: true,
  openBlankTargetInWebView: true,
  hiddenPopupWindow: true,
  outboundProxyRules: [
    {
      urlRegex: '^https://example\\.com/api/',
      action: 'delegateToJs',
    },
  ],
});

await InAppBrowser.postMessage({
  id,
  detail: { source: 'app', action: 'refresh' },
});

适用于以下场景:

全参考

继续使用@capgo/capacitor-inappbrowser

如果您正在使用 使用@capgo/capacitor-inappbrowser 来规划原生插件工作,连接它与 @capgo/capacitor-inappbrowser 了解@capgo/capacitor-inappbrowser 实现细节在Getting Started, Getting Started 实现细节在Getting Started,中了解有关原生插件的工作原理,在Capgo的插件目录中查看Capgo 为产品工作流程在Capgo插件目录中 Capacitor插件由Capgo提供 为Capacitor插件由Capgo的实现细节 添加或更新插件 添加或更新插件的实现细节