@capgo/capacitor-inappbrowser

概要

@capgo/capacitor-inappbrowser gives Capacitor apps two browser paths: open() 管理されたネイティブのWebViewのパス openWebView() Ionic UIと組み合わせて、サイズ、非表示、メッセージ、スクリプト、プロキシ、レイヤーを実行できます。

外部ブラウザでは実現できないOAuthとチェックアウトフロー、エンメデッドサポートポータル、決済画面、ビデオコール、ドキュメントポータル、インタラクティブなWebアプリ、またはライブWebコンテンツにネイティブなコントロールを必要とするあらゆるフローで使用してください。

パッケージ名が変更されました。

一般的な使用例

• イオニクンまたはCapacitor UI をライブブラウザページの上に表示します。 toBack, sendToBack(), bringToFront(), transparentBackground, および dispatchInputEvent().
• 部分スクリーンブラウザ、ボトムシート、ピクチャインピクチャーWebビューを構築します。 width, height, x, y, および updateDimensions().
• AndroidおよびiOSでカスタムサイズのブラウザフレーム外でCapacitorアプリをタップしてください。
• チェックアウト、ログイン、サポート、またはアカウント切り替えフローを実行して、永続的なウェブサイトストレージを使用せずに。 persistWebViewData: false および clearAllBrowsingData().
• 複数のブラウザ インスタンスをロードして hidden, hide(), そして show() ページの状態を保存する
• Google Pay のサポート、リンク ハンドリング、そしてアプリからページへのメッセージングを含む、ファイルのアップロード、ダウンロード、ポップアップの制御を必要とする高度な Web アプリを埋め込む _blank Core Capabilities

Core Capabilities

• open - カスタム ツールバー、サイズ、ネイティブ ナビゲーション、メッセージング、スクリプティング、プロキシ、ダウンロード、ポップアップ、データ制御を備えたマネージド ネイティブ WebView を開く SFSafariViewController - __CAPGO_KEEP_0__ ホスト WebView の後ろまたは上にマネージド ブラウザを移動する
• openWebView - ネイティブ アプリ UI の後ろにあるブラウザにクリック、タッチ、スクロール イベントを転送する
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent - カスタム ツールバー、サイズ、ネイティブ ナビゲーション、メッセージング、スクリプティング、プロキシ、ダウンロード、ポップアップ、データ制御を備えたマネージド ネイティブ WebView を開く
• updateDimensions - WebViewのサイズと位置を変更する
• hide / show - WebViewをロードしたまま、またはそのネイティブ表示を削除または復元する
• postMessage / executeScript - Capacitorアプリと、WebView内で実行されているJavaScriptを接続する
• clearAllBrowsingData / persistWebViewData - Cookie、キャッシュ、ストレージ、IndexedDB、セッションの永続化を制御する
• handleDownloads- プロキシルール、ポップアップイベント - ドキュメントポータル、アップロードフロー、支払いページ、埋め込まれたWebアプリをサポートする

Public API

メソッド	説明
goBack	WebViewの履歴を戻す
open	URLを開く
clearCookies	URLのクッキーをクリアする id 省略した場合、すべてのオープンなウェブビューに適用されます。
clearAllCookies	すべてのクッキーを削除する When id 省略した場合、すべてのオープンなウェブビューに適用されます。
clearCache	キャッシュをすべて削除する When id 省略した場合、すべてのオープンなウェブビューに適用されます。
clearAllBrowsingData	デフォルトのストアとマネージドのウェブビューから、クッキー、キャッシュ、ローカルストレージ、セッションストレージ、IndexedDB、他のブラウジングデータをクリアします。
getCookies	特定のURLのクッキーを取得します。
close	ウェブビューを閉じます。 When id 省略した場合、現在のウェブビューを閉じます。
hide	ウェブビューを非表示にしますが、閉じません。 show() を使用して元に戻すことができます。 When id 省略した場合、現在のウェブビューをターゲットにします。
show	以前のウェブビューを表示します。 When id は省略されると、現在のウェブビューをターゲットにします。
sendToBack	Moves the native browser behind the Capacitor host WebView so app UI can appear above it.
bringToFront	ホストのWebViewの背後にあるブラウザを前面に戻します。
dispatchInputEvent	マネージドブラウザにクリック、タッチ、またはスクロール入力を送信します。座標はブラウザのビュー ポートに相対的です。
openWebView	ツールバーと拡張機能、カメラアクセス、ファイルアクセス、イベントリスニング、JavaScriptのインジェクション、双方向通信などを備えた新しいウェブビューでURLを開きます。
executeScript	Injects JavaScript code into the InAppBrowser window. When id は省略されると、すべての開いているウェブビューで実行されます。
postMessage	ウェブビュー (インアプリブラウザ) にイベントを送信します。ページで window.addEventListener('messageFromNative', listenerFunc)を使用してリスンします。 detail ウェブビューのペイロードはJSONシリアライズ可能でなければなりません。 id は省略されると、すべての開いているウェブビューにブロードキャストされます。
takeScreenshot	現在のウェブビューのビュー ポートをPNG形式のスクリーンショットとしてキャプチャします。 id 省略すると、現在のウェブビューをターゲットにします。
setUrl	ウェブビューのURLを設定します。省略すると、現在のウェブビューをターゲットにします。 id openWebViewのみで、URLの変更をリスンします。
addListener	openWebViewのみで、リスンします。
addListener	openWebViewのみで、クリックをリスンします。 buttonNearDoneClickユーザーが確認ボタンをクリックしたときに発火します。ディスクリーマーが必要な場合、openWebViewのshareDisclaimerとcloseModalと一緒に使用します。 id.
addListener	ウェブビューがアプリにイベントを送信したときに発火します。page内で使用し、ペイロードをJSONシリアライズ可能に保ちます。
addListener	プラグイン__CAPGO_KEEP_0__、ネイティブのスクリーンショットボタン、またはインジェクションされたJavaScriptブリッジからスクリーンショットがキャプチャされたときに発火します。
addListener	ページが読み込まれたときに発火します。 window.mobileApp.postMessage(...) openWebViewのみで、ページが読み込まれたときに発火します。
addListener	Will be triggered whenever a screenshot is captured from the plugin API, the native screenshot button, or the injected JavaScript bridge.
addListener	openWebViewのみで、ページが読み込まれたときに発火します。
addListener	ページ読み込みエラーが発生したときにトリガーされます。
addListener	ネイティブのダウンロード処理がローカルにファイルを保存した後、トリガーされます。有効にするには handleDownloads: true Webビューを開いたときにトリガーされます。
addListener	ネイティブのダウンロード処理が失敗したときにトリガーされます。有効にするには handleDownloads: true Webビューを開いたときにトリガーされます。
addListener	ページがポップアップ/新しいウィンドウを開いたときにトリガーされます。返されたポップアップIDを executeScript, postMessage, show, hideと close.
addListener	ネイティブランタイムによって委譲されたプロキシリクエストをリスンします。代わりに addProxyHandler() を呼び出すのではなく
addListener	ネイティブランタイムによって委譲されたプロキシリクエストをリスンします。代わりに captureConsoleLogs: true を呼び出すのではなく
handleProxyRequest	JavaScriptコンソール出力がマネージドページによって発行されたときにトリガーされます。有効にするには addProxyHandler() 原生にプロキシの決定を送信するために、元のものを前方に送信します。 phase 手動の返信の場合に使用します。 proxyRequest リスナー。
removeAllListeners	このプラグインのすべてのリスナーを削除します。
reload	現在のWebページを再読み込みします。
updateDimensions	Webビューの寸法を更新します。実行時にはサイズと位置を変更できます。省略すると、現在のWebビューをターゲットにします。 id 省略すると、現在のWebビューをターゲットにします。Web上では、このメソッドはレイアウトを変更せずに解決します。
setEnabledSafeTopMargin	省略すると、現在のWebビューをターゲットにします。Web上では、このメソッドはレイアウトを変更せずに解決します。 id Webビューの有効な安全上部マージンを実行時に設定します。省略すると、現在のWebビューをターゲットにします。Web上では、このメソッドはレイアウトを変更せずに解決します。
setEnabledSafeBottomMargin	Webビューの有効な安全下部マージンを実行時に設定します。省略すると、現在のWebビューをターゲットにします。Web上では、このメソッドはレイアウトを変更せずに解決します。 id 安全なOAuth2ウィンドウを開きます。Web上では、リダイレクトされたURLを返します。
openSecureWindow	Opens a secure OAuth2 window. On web, return the redirected URL through a BroadcastChannel;モバイルでは、カスタムリダイレクトURIをアプリの設定に登録してください。詳細は、HTML、Info.plist、AndroidManifestの例を参照してください。

Reference Values

これらの値を、インアプリブラウザまたはWebViewを開く際のツールバーのオプションと組み合わせて使用してください。

Toolbar Types

Value	ユーザーは次のことを見つけることができます。
activity	閉じると共に共有ボタンが付いたシンプルなツールバー。
compact	閉じるボタンが付いたシンプルなツールバー。
navigation	前進と戻るボタンが付いたフルナビゲーションツールバー。
blank	ツールバーが付いていない。

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-inappbrowser.

capgoから続けて@capacitor/capgo-inappbrowser

If you are using @capgo/capacitor-inappbrowser を使用してネイティブ プラグインの作業を計画する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-inappbrowser を@capgo/capacitor-inappbrowser for the native capability in Using @capgo/capacitor-inappbrowser, Capgo プラグインディレクトリ Capgo製品ワークフロー向け Capacitor Capgo によって提供されるプラグイン Capacitor実装詳細向け Capgo によって提供されるプラグイン プラグインの追加または更新 プラグインの追加または更新の実装詳細向け、 イオニック エンタープライズ プラグインの代替 __CAPGO_KEEP_0__製品ワークフロー向けイオニック エンタープライズ プラグインの代替