スタートガイド
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-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.
インストール
「インストール」セクションAIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins次に、以下のプロンプトを使用します:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-inappbrowser` plugin in my project.手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください:
npm install @capgo/capacitor-inappbrowsernpx cap syncインポート
「インポート」セクションimport { InAppBrowser } from '@capgo/capacitor-inappbrowser';クイックスタート:マネージドWebViewでホスト型チェックアウト
「クイックスタート: マネージド WebView でのホスト型チェックアウト」セクションimport { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({ url: 'https://billing.example.com/checkout', toolbarType: 'navigation', title: 'Checkout',});
InAppBrowser.addListener('urlChangeEvent', (event) => { if (event.url.includes('/success')) { InAppBrowser.close(); }});使用する open() フルネイティブ WebView スタックを埋め込まずに、Safari View Controller や Chrome Custom Tabs を使用したい場合に代わりに使用します。
ブラウザモードを選択
セクション「ブラウザモードの選択」使用する open() プラットフォームのブラウザサーフェスを使いたい場合:AndroidではChrome Custom Tabs、 SFSafariViewController iOSでは標準ブラウザを使用します。 openWebView() アプリでネイティブWebViewを制御する必要がある場合に適しています(カスタムサイズ、ツールバー、アプリとのメッセージング、JavaScript注入、ダウンロード、プロキシ、ポップアップ、非表示インスタンス、UIレイヤーなど)。
よくあるユースケース
「よくあるユースケース」セクションライブブラウザページ上にIonic UIを表示する
「ライブブラウザページ上にIonic UIを表示する」セクションCapacitorホストWebViewの背後で管理対象のWebViewを開くには、 toBack。これにより、Webコンテンツを背後にロードしたまま、Ionic UIをページの上にレンダリングできます。ジェスチャーをブラウザに転送するには dispatchInputEvent() オーバーレイがページと対話する必要がある場合に使用します。
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 });ブラウザを表示させたい箇所では、アプリの該当する背景を透過させてください。ブラウザがアプリの背後にある場合、明示的に転送しない限り、ネイティブジェスチャーは引き続きCapacitor WebViewが制御します。
部分画面ブラウザまたはボトムシートを構築
セクション: 「部分画面ブラウザまたはボトムシートを構築する」設定 height, width, xや y ネイティブブラウザの周囲で Capacitor アプリの一部を表示し続けるために使用します。Android および iOS では、ブラウザフレーム外のタッチは、下層の Capacitor WebView に透過して伝達されます。
const bottomGap = 200;
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/offers', height: window.innerHeight - bottomGap, y: 0,});
await InAppBrowser.updateDimensions({ id, height: window.innerHeight, y: 0,});ミニブラウザ、オファーパネル、サポートウィジェット、ブラウザベースのボトムシート、または Web コンテンツの外側でネイティブアプリのコントロールをタップ可能に保つ必要があるフローに使用します。
決済、認証、サポートセッションのプライバシーを保護
セクション: 「チェックアウト、認証、またはサポートセッションをプライベートに保つ」設定 persistWebViewData: false プラットフォームがサポートしている場合、永続的なウェブサイトデータを避けるべき管理対象の WebView に使用します。呼び出し clearAllBrowsingData() ログアウト、アカウント切り替え、テストセッション、またはデフォルトのストアと開かれた管理対象の WebView をクリアする必要があるフローの後に実行します。
const { id } = await InAppBrowser.openWebView({ url: 'https://example.com/login', persistWebViewData: false,});
await InAppBrowser.clearAllBrowsingData();await InAppBrowser.close({ id });Android では、Cookie はシステムの WebView Cookie ストアを使用するため、 clearAllBrowsingData() は Cookie およびその他の共有ブラウザデータのクリーンアップ手順です。
複数のブラウザインスタンスを利用可能な状態に保つ
セクション「複数のブラウザインスタンスを準備しておく」使用する hidden, hide()や show() 各 WebView を画面に表示したままにせずに、複数の管理対象の WebView を事前読み込みまたは保持するために使用します。非表示の WebView でも引き続き executeScript(), postMessage(), setUrl()およびクローズ呼び出しを受け取ることができます。
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アプリフローを埋め込み
セクション「高度なWebアプリフローの埋め込み」プロキシルールを組み合わせ、 handleDownloads, openBlankTargetInWebView, hiddenPopupWindow, enableGooglePaySupport, postMessage()や executeScript() ドキュメントポータル、アップロードフロー、決済ページ、サポートデスクなど、アプリを離れずにネイティブ制御が必要な埋め込み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' },});API の概要
「API 概要」セクションgoBack
セクション「goBack」WebViewの履歴があれば、前の画面に戻ります
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.goBack();open
セクション「open」URL を新しいウィンドウでフルスクリーンに開きます。Android では Chrome カスタムタブ、iOS では SFSafariViewController を使用します。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.open({} as OpenOptions);clearCookies
「clearCookies」セクションURL の Cookie をクリア
タイミング id 省略された場合、開いているすべてのWebViewに適用されます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCookies({} as ClearCookieOptions);clearAllCookies
「clearAllCookies」セクションすべての Cookie をクリア
タイミング id 省略された場合、開いているすべてのWebViewに適用されます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllCookies();clearCache
「clearCache」セクションキャッシュをクリア
タイミング id 省略された場合、開いているすべてのWebViewに適用されます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearCache();clearAllBrowsingData
「clearAllBrowsingData」セクションデフォルトストアおよび開いている管理対象のWebViewから、Cookie、キャッシュ、local storage、session storage、IndexedDB、フォームデータ、HTTP認証データなど、プラットフォームが公開しているすべての閲覧データを削除します。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.clearAllBrowsingData();getCookies
「getCookies」セクション特定のURLのCookieを取得します。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.getCookies({} as GetCookieOptions);close
「close」セクションWebViewを閉じます。
id 省略された場合は、アクティブなWebViewを閉じます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.close();hide
「hide」セクションWebViewを閉じずに非表示にします。
再表示するには show() を使用してください。
id を省略すると、アクティブなWebViewが対象になります。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.hide();show
「show」セクション非表示にしていたWebViewを表示します。
次の場合: id を省略すると、アクティブなWebViewが対象になります。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.show();sendToBack
「sendToBack」セクションネイティブブラウザを Capacitor ホストWebViewの背面に移動します。Ionic UIを表示中のブラウザページより前面に出したいときに使用します。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.sendToBack({ id: 'webview-id', transparentBackground: true });bringToFront
「bringToFront」セクションホストWebViewの背面にあったブラウザを前面に戻します。次の場合: id を省略すると、アクティブなWebViewが対象になります。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.bringToFront({ id: 'webview-id' });dispatchInputEvent
セクション「dispatchInputEvent」管理対象ブラウザにクリック、タッチ、スクロールイベントをディスパッチします。座標はブラウザのビューポートを基準としたCSSピクセル単位です。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.dispatchInputEvent({ id: 'webview-id', type: 'click', x: 160, y: 420,});openWebView
セクション「openWebView」ツールバーを備えた新しいWebViewでURLを開きます。カメラやファイルへのアクセス、イベントのリスニング、JavaScriptの注入、双方向通信などの高度な機能を利用できます。
JavaScriptインターフェース: このメソッドでWebViewを開くと、次の機能を提供するJavaScriptインターフェースが自動的に注入されます:
window.mobileApp.close(): JavaScriptからWebViewを閉じますwindow.mobileApp.postMessage({detail: {message: "myMessage"}}): WebViewからアプリへメッセージを送信します。detailオブジェクトはWebViewに送信するデータですwindow.mobileApp.takeScreenshot()いつallowScreenshotsFromWebPageが true の場合
プラットフォームによって Promise のタイミングが異なる場合 isPresentAfterPageLoad を使用する場合。
Android は { id } で解決され、iOS は { id } ネイティブ WebView を作成した直後に解決されます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.openWebView({} as OpenWebViewOptions);executeScript
セクション「executeScript」InAppBrowser ウィンドウに JavaScript code を注入します。
id を省略すると、開いているすべてのWebViewで実行されます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.executeScript({} as { code: string; id?: string });postMessage
セクション「postMessage」WebView(アプリ内ブラウザ)にイベントを送信します。WebView の JavaScript では、これを以下で監視します。 window.addEventListener('messageFromNative', listenerFunc).
detail は WebView に送信されるペイロードです。Capacitor ブリッジをまたぐため、JSON シリアライズ可能である必要があります。
id 省略すると、開いているすべてのwebviewにブロードキャストされます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.postMessage({} as { detail: Record<string, any>; id?: string });takeScreenshot
「takeScreenshot」セクション現在のWebViewビューポートをPNGスクリーンショットとしてキャプチャします。
実行タイミング: id を省略すると、アクティブなWebViewが対象になります。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.takeScreenshot();setUrl
「setUrl」セクションWebViewのURLを設定します。
実行タイミング: id を省略すると、アクティブなWebViewが対象になります。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setUrl({} as { url: string; id?: string });handleProxyRequest
「handleProxyRequest」セクション内部で使用されるメソッド: addProxyHandler() プロキシの決定をネイティブ側に返すため。
元のリクエストを転送します。 phase 手動への返信時に proxyRequest リスナーを通じて通知されます。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.handleProxyRequest({} as { requestId: string; decision?: ProxyDecision | null; response?: ProxyResponse | null; webviewId?: string; phase?: 'outbound' | 'inbound'; });reload
「reload」セクション現在のWebページを再読み込みします。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.reload();updateDimensions
「updateDimensions」セクションWebviewの寸法を更新します。
実行時にWebviewのサイズと位置を変更できます。
id を省略すると、アクティブなWebViewが対象になります。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.updateDimensions({} as DimensionOptions & { id?: string });setEnabledSafeTopMargin
「setEnabledSafeTopMargin」セクション実行時に WebView の有効な安全上マージンを設定します。
id 省略された場合、アクティブな WebView が対象になります。
Web ではこのメソッドは no-op で、レイアウトを変更せずに resolve します。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeTopMargin({} as { enabled: boolean; id?: string });setEnabledSafeBottomMargin
セクション「setEnabledSafeBottomMargin」実行時に WebView の有効なセーフボトムマージンを設定します。
以下の場合: id 省略された場合、アクティブな WebView が対象になります。
Web ではこのメソッドは no-op で、レイアウトを変更せずに resolve します。
import { InAppBrowser } from '@capgo/capacitor-inappbrowser';
await InAppBrowser.setEnabledSafeBottomMargin({} as { enabled: boolean; id?: string });openSecureWindow
セクション「openSecureWindow」OAuth2 認証用のセキュアウィンドウを開きます。 Web の場合、リダイレクト先のページに code を用意し、ブロードキャストチャネルを使ってリダイレクト先の URL をアプリに送信する必要があります。 例えば次のように:
<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>