@capgo/capacitor-inappbrowser

Ringkasan

@capgo/capacitor-inappbrowser memberikan aplikasi Capacitor dua jalur browser: open() untuk pengalaman browser sistem dan openWebView() untuk WebView native yang diatur yang dapat diukur, disembunyikan, dikirimkan pesan, dieksekusi skrip, di-proxy, dan dilapis dengan UI Ionic.

Gunakan hal ini ketika halaman memerlukan lebih dari browser eksternal sederhana: alur OAuth dan pembayaran, portal dukungan terintegrasi, layar pembayaran, panggilan video, portal dokumen, aplikasi web interaktif, atau alur mana pun di mana aplikasi Anda memerlukan kontrol asli di sekitar konten web yang hidup.

Nama paket berubah.

Penggunaan Umum

• Tampilkan antarmuka Ionic atau Capacitor di atas halaman browser yang hidup dengan toBack, sendToBack(), bringToFront(), transparentBackground, dan dispatchInputEvent().
• Buat browser layar setengah, sheet bawah, dan tampilan web dalam gambar dengan width, height, x, y, dan updateDimensions().
• Biarkan pengguna mengetuk aplikasi Capacitor di luar frame browser ukuran kustom pada Android dan iOS.
• Jalankan alur pembayaran, login, dukungan, atau alur perubahan akun tanpa penyimpanan situs yang berlangsung menggunakan persistWebViewData: false dan clearAllBrowsingData().
• Teruskan beberapa instance browser yang dimuat dengan hidden, hide(), dan show() menghemat keadaan halaman.
• Integrasikan aplikasi web canggih yang memerlukan proxy permintaan, unggahan file, download, pengendalian popup, dukungan Google Pay, pengelolaan link, dan pesan aplikasi ke halaman. _blank Kemampuan Utama

Judul bagian “Kemampuan Utama”

• open - Membuka WebView native yang diatur dengan toolbar kustom, ukuran, navigasi native, pesan, skrip, proxy, download, popup, dan kontrol data. SFSafariViewController - Menggeser browser yang diatur ke belakang atau di atas WebView host __CAPGO_KEEP_0__.
• openWebView - Mengalihkan peristiwa klik, sentuh, dan gulir ke browser yang berada di belakang UI aplikasi native.
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent Core Capabilities
• updateDimensions - Mengubah ukuran dan posisi WebView yang diatur tanpa memuat ulang halaman.
• hide / show - Menjaga WebView yang diatur tetap dimuat sementara menghapus atau mengembalikan presentasi aslinya.
• postMessage / executeScript - Menghubungkan aplikasi Capacitor dengan JavaScript yang berjalan di dalam halaman yang diatur.
• clearAllBrowsingData / persistWebViewData - Mengontrol cookie, cache, penyimpanan, IndexedDB, dan persistensi sesi.
• handleDownloads- Pengaturan proxy, dan event popup - Mendukung portal dokumen, aliran unggah, halaman pembayaran, dan aplikasi web terintegrasi.

- Aplikasi API yang terbuka.

- Metode	- Deskripsi
goBack	- Membalikkan sejarah di WebView jika memungkinkan.
open	- Membuka URL di jendela baru fullscreen, di android menggunakan chrome custom tabs, di ios menggunakan SFSafariViewController.
clearCookies	- Membersihkan cookie URL ketika id ditinggalkan, berlaku untuk semua webview terbuka.
clearAllCookies	Hapus semua cookie Ketika id ditinggalkan, berlaku untuk semua webview terbuka.
clearCache	Hapus cache Ketika id ditinggalkan, berlaku untuk semua webview terbuka.
clearAllBrowsingData	Menghapus cookie, cache, penyimpanan lokal, penyimpanan sesi, IndexedDB, dan data browsing lainnya dari penyimpanan default dan WebView yang diatur.
getCookies	Dapatkan cookie untuk URL tertentu.
close	Tutup webview. Ketika id ditinggalkan, menutup webview aktif.
hide	Sembunyikan webview tanpa menutupnya. Gunakan show() untuk mengembalikannya. Ketika id ditinggalkan, mengarahkan ke webview aktif.
show	Tampilkan kembali webview yang sebelumnya disembunyikan. Ketika id dijalankan, mengarahkan ke webview aktif.
sendToBack	Menggeser browser native di belakang Capacitor host WebView sehingga UI aplikasi dapat muncul di atasnya.
bringToFront	Menggeser browser yang berada di belakang host WebView ke depan.
dispatchInputEvent	Mengirimkan input klik, sentuh, atau gulir ke browser yang diatur; koordinat relatif terhadap viewport browser.
openWebView	Membuka URL di webview baru dengan toolbar dan kemampuan yang ditingkatkan, seperti akses kamera, akses file, mendengarkan event, menginjeksi JavaScript, komunikasi dua arah, dll.
executeScript	Menginjeksi JavaScript code ke jendela InAppBrowser. Ketika id dijalankan, mengarahkan ke semua webview terbuka.
postMessage	Mengirimkan event ke webview (browser dalam aplikasi). Mendengarkan di halaman dengan window.addEventListener('messageFromNative', listenerFunc)payload harus dapat di serialisasi ke JSON. Ketika detail dijalankan, mengirimkan ke semua webview terbuka. id Mengambil tangkapan layar webview saat ini sebagai screenshot PNG. Ketika
takeScreenshot	__CAPGO_KEEP_0__ id dihapus, mengarah ke webview aktif.
setUrl	Mengatur URL webview. Ketika id dihapus, mengarah ke webview aktif.
addListener	Tunggu perubahan URL, hanya untuk openWebView.
addListener	Tunggu buttonNearDoneClick; isi payload berisi webview id.
addListener	Tunggu klik close hanya untuk openWebView.
addListener	Akan diaktifkan ketika pengguna mengklik tombol konfirmasi ketika disclaimer diperlukan, bekerja dengan openWebView shareDisclaimer dan closeModal.
addListener	Dipicu ketika webview mengirimkan event kembali ke aplikasi. Gunakan window.mobileApp.postMessage(...) di halaman, dan simpan payload JSON-serializable.
addListener	Akan diaktifkan setiap kali screenshot diambil dari plugin API, tombol screenshot native, atau jembatan JavaScript yang diinjeksikan.
addListener	Akan diaktifkan ketika halaman dimuat.
addListener	Akan diaktifkan ketika terjadi kesalahan muat halaman.
addListener	Akan diaktifkan setelah pengelolaan download native menyimpan file secara lokal. Aktifkan fitur ini dengan handleDownloads: true ketika membuka webview.
addListener	Akan diaktifkan ketika pengelolaan download native gagal. Aktifkan fitur ini dengan handleDownloads: true ketika membuka webview.
addListener	Akan diaktifkan setiap kali halaman membuka popup/tangkapan layar baru. Gunakan id popup yang dikembalikan dengan executeScript, postMessage, show, hide, dan close.
addListener	Tetapkan untuk mendengarkan permintaan proxy yang diwakilkan oleh runtime native. Lebih baik addProxyHandler() dibandingkan dengan memanggilnya secara langsung.
addListener	Tetapkan untuk mendengarkan keluaran konsol JavaScript yang dihasilkan oleh halaman yang dielola. Aktifkan fitur ini dengan captureConsoleLogs: true ketika membuka webview.
handleProxyRequest	Metode internal yang digunakan oleh addProxyHandler() Mengirimkan keputusan proxy kembali ke native. Kirimkan aslinya. phase Mengirimkan keputusan proxy kembali ke native. Kirimkan aslinya ketika menjawab manual. proxyRequest Menggunakan pemanggil.
removeAllListeners	Menghapus semua pemanggil untuk plugin ini.
reload	Mengisi ulang halaman web saat ini.
updateDimensions	Mengupdate dimensi webview. Memungkinkan mengubah ukuran dan posisi webview secara waktu eksekusi. Ketika id Mengatur margin atas aman yang diaktifkan webview secara waktu eksekusi. Ketika
setEnabledSafeTopMargin	Mengatur margin bawah aman yang diaktifkan webview secara waktu eksekusi. Ketika id Membuka jendela OAuth2 yang aman. Pada web, kembalikan URL yang diarahkan melalui
setEnabledSafeBottomMargin	__CAPGO_KEEP_0__ id __CAPGO_KEEP_1__
openSecureWindow	__CAPGO_KEEP_2__ BroadcastChanneldi ponsel, daftarkan URI redirect kustom di konfigurasi aplikasi Anda. Lihat panduan getting-started untuk contoh HTML, Info.plist, dan AndroidManifest yang lengkap.

Nilai Referensi

Gunakan nilai-nilai ini dengan opsi toolbar ketika membuka browser dalam aplikasi atau WebView.

Jenis Toolbar

Nilai	Pengguna akan menemukan
activity	Toolbar sederhana dengan kontrol tutup dan berbagi.
compact	Toolbar sederhana dengan kontrol tutup.
navigation	Toolbar navigasi lengkap dengan kontrol mundur dan maju.
blank	Tidak ada toolbar.

Sumber Kebenaran

Referensi ini disinkronkan dari src/definitions.ts di capacitor-inappbrowser.

Teruskan dari @capgo/capacitor-inappbrowser

Jika Anda menggunakan @capgo/capacitor-inappbrowser untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-inappbrowser untuk kemampuan native di Menggunakan @capgo/capacitor-inappbrowser, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.