@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 fitur 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 native di sekitar konten web yang aktif.

Nama paket diubah.

Penggunaan Umum

• Present Ionic or Capacitor UI above a live browser page with toBack, sendToBack(), bringToFront(), transparentBackground, dan dispatchInputEvent().
• Buat browser layar setengah, sheet bawah, dan tampilan web dalam gambar dengan width, height, x, y, dan updateDimensions().
• Let users tap the Capacitor app outside a custom-size browser frame on Android and iOS.
• Jalankan alur pembayaran, login, dukungan, atau alur perubahan akun tanpa penyimpanan situs yang persisten 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, unggah file, unduh file, kontrol popup, dukungan Google Pay, pengaturan link, dan pesan aplikasi ke halaman. _blank Kemampuan Utama

Bab berjudul “Kemampuan Utama”

• open - Membuka WebView native yang diatur dengan toolbar kustom, ukuran, navigasi native, pesan, skrip, proxy, unduh, 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 terisi 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 publik.

- Metode	- Deskripsi
goBack	- Membalikkan ke dalam sejarah 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 terlepas, berlaku untuk semua webview terbuka.
clearAllCookies	Membersihkan semua cookie Ketika id terlepas, berlaku untuk semua webview terbuka.
clearCache	Membersihkan cache Ketika id terlepas, 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	Mengambil cookie untuk URL tertentu.
close	Menghapus webview. Ketika id terlepas, menutup webview aktif.
hide	Menghilangkan webview tanpa menutupnya. Gunakan show() untuk mengembalikannya. Ketika id terlepas, mengarahkan pada webview aktif.
show	Mengembalikan webview yang sebelumnya disembunyikan. Ketika id dihilangkan, mengarahkan ke webview aktif.
sendToBack	Menggerakkan browser native di belakang Capacitor host WebView sehingga UI aplikasi dapat muncul di atasnya.
bringToFront	Mengembalikan browser yang berada di belakang host WebView ke depan.
dispatchInputEvent	Mengirimkan input klik, sentuh, atau scroll 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 dihilangkan, dieksekusi di semua webview terbuka.
postMessage	Mengirimkan event ke webview (browser di dalam aplikasi). Dengarkan di halaman dengan window.addEventListener('messageFromNative', listenerFunc). Harus ada detail payload yang dapat di serialisasi ke JSON. Ketika id dihilangkan, mengirimkan ke semua webview terbuka.
takeScreenshot	Mengambil tangkapan layar webview saat ini sebagai screenshot PNG. Ketika id ditinggalkan, mengarah ke webview aktif.
setUrl	Mengatur URL webview. Ketika id ditinggalkan, mengarah ke webview aktif.
addListener	Tunggu perubahan URL, hanya untuk openWebView.
addListener	Tunggu buttonNearDoneClick; isi payload berisi webview id.
addListener	Tunggu klik tutup 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(...) dalam halaman, dan simpan isi payload dalam format JSON yang dapat di serialisasi.
addListener	Akan diaktifkan ketika 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 Akan diaktifkan ketika pengelolaan download native gagal. Aktifkan fitur ini dengan
addListener	Akan diaktifkan ketika pengguna membuka halaman web. handleDownloads: true Akan diaktifkan ketika pengguna membuka halaman web.
addListener	Akan diaktifkan setiap kali halaman web membuka popup/tangkapan layar baru. Gunakan ID popup yang dikembalikan dengan executeScript, postMessage, show, hide, dan close.
addListener	Dengarkan permintaan proxy yang diwakilkan oleh runtime native. Lebih baik addProxyHandler() daripada memanggilnya secara langsung.
addListener	Dengarkan keluaran konsol JavaScript yang dihasilkan oleh halaman yang dielola. Aktifkan fitur ini dengan captureConsoleLogs: true Akan diaktifkan ketika pengguna membuka halaman web.
handleProxyRequest	Methode 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 pemangku jawab.
removeAllListeners	Menghapus semua pemangku jawab untuk plugin ini.
reload	Mengisi ulang halaman web saat ini.
updateDimensions	Mengupdate dimensi dari webview. Memungkinkan mengubah ukuran dan posisi webview secara waktu eksekusi. Ketika id Mengatur margin atas yang aman diaktifkan dari webview secara waktu eksekusi. Ketika
setEnabledSafeTopMargin	Mengatur margin bawah yang aman diaktifkan dari 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 pengalihan kustom di konfigurasi aplikasi Anda. Lihat panduan getting-started untuk contoh HTML, Info.plist, dan AndroidManifest yang lengkap.

Nilai Referensi

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

Jenis Toolbar

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

Sumber Kebenaran

Referensi ini disinkronkan dari src/definitions.ts in 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, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin Capacitor oleh 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.