@capgo/capacitor-inappbrowser

Ringkasan

@capgo/capacitor-inappbrowser memberikan Capacitor dua jalur browser: open() untuk pengalaman browser sistem dan openWebView() untuk WebView native yang diatur yang aplikasi Anda dapat mengatur ukuran, menyembunyikan, mengirimkan pesan, menulis skrip, mengarahkan proxy, dan menambahkan layer dengan UI Ionic.

Gunakanlah ketika halaman memerlukan lebih dari browser eksternal sederhana: alur OAuth dan checkout, 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 hidup.

Nama paket berubah.

Penggunaan Umum

• Tampilkan UI Ionic atau Capacitor di atas halaman browser yang hidup dengan toBack, sendToBack(), bringToFront(), transparentBackgrounddan dispatchInputEvent().
• Bangun peramban layar setengah, lembar bawah, dan tampilan gambar dalam gambar web dengan width, height, x, ydan updateDimensions().
• Biarkan pengguna mengetuk aplikasi Capacitor di luar kerangka peramban ukuran kustom pada Android dan iOS.
• Jalankan alur pemesanan, login, dukungan, atau perubahan akun tanpa penyimpanan situs web yang berlangsung menggunakan persistWebViewData: false dan clearAllBrowsingData().
• Tahan beberapa instance peramban yang dimuat dengan hidden, hide(), dan show() sambil menjaga keadaan halaman.
• Integrasikan aplikasi web maju yang memerlukan proxy permintaan, unggahan file, unduhan, kontrol popup, dukungan Google Pay, _blank pengaturan tautan, dan pesan aplikasi ke halaman.

Kemampuan Utama

• open - Membuka URL di Chrome Custom Tabs pada Android atau SFSafariViewController - di iOS.
• openWebView - Membuka WebView native yang diatur dengan toolbar, ukuran, navigasi native, pesan, skrip, proxy, download, popup, dan pengendalian data.
• sendToBack / bringToFront - Menggerakkan browser yang diatur ke belakang atau di atas WebView host Capacitor.
• dispatchInputEvent - Mengalirkan peristiwa klik, sentuh, dan gulir ke browser yang berada di belakang antarmuka aplikasi native.
• updateDimensions - Mengubah ukuran dan posisi WebView yang diatur tanpa memuat ulang halaman.
• hide / show - Menjaga WebView yang diatur tetap dimuat sementara menghilangkan atau mengembalikan presentasi native mereka.
• postMessage / executeScript - Menghubungkan Capacitor aplikasi dengan JavaScript yang berjalan di dalam halaman yang diatur.
• clearAllBrowsingData / persistWebViewData - Mengendalikan persistensi cookie, cache, penyimpanan, IndexedDB, dan sesi - Support portal dokumen, aliran unggah, halaman pembayaran, dan aplikasi web terintegrasi.
• handleDownloadsPublik __CAPGO_KEEP_0__

Public API

Metode	Deskripsi
goBack	Mengembalikan ke sejarah WebView jika memungkinkan.
open	Membuka url di jendela baru fullscreen, di android menggunakan chrome custom tabs, di ios menggunakan SFSafariViewController.
clearCookies	Menghapus cookie url Ketika id jika tidak ada, berlaku untuk semua webview terbuka.
clearAllCookies	Menghapus semua cookie Ketika id jika tidak ada, berlaku untuk semua webview terbuka.
clearCache	Menghapus cache Ketika id jika tidak ada, berlaku untuk semua webview terbuka.
clearAllBrowsingData	Menghapus semua cookie, cache, penyimpanan lokal, penyimpanan sesi, IndexedDB, dan data browsing lainnya dari penyimpanan default dan WebView yang diatur.
getCookies	Ambil kuki untuk URL tertentu.
close	Tutup webview. Ketika __CAPGO_KEEP_0__ dihilangkan, tutup webview aktif. id Sembunyikan webview tanpa menutupnya. Gunakan show() untuk mengembalikannya. Ketika __CAPGO_KEEP_0__ dihilangkan, sasaran webview aktif.
hide	Tampilkan kembali webview yang disembunyikan sebelumnya. Ketika __CAPGO_KEEP_0__ dihilangkan, sasaran webview aktif. id Pindahkan browser native di belakang host WebView agar UI aplikasi dapat muncul di atasnya.
show	Pindahkan browser yang berada di belakang host WebView ke depan. id Kirimkan input klik, sentuh, atau gulir ke browser yang diatur; koordinat relatif terhadap viewport browser.
sendToBack	Moves the native browser behind the Capacitor host WebView so app UI can appear above it.
bringToFront	Injeksikan JavaScript __CAPGO_KEEP_0__ ke jendela InAppBrowser. Ketika __CAPGO_KEEP_0__ dihilangkan, sasaran webview aktif.
dispatchInputEvent	Injects JavaScript __CAPGO_KEEP_0__ into the InAppBrowser window. When __CAPGO_KEEP_0__ is omitted, targets the active webview.
openWebView	Injects JavaScript __CAPGO_KEEP_0__ into the InAppBrowser window. When __CAPGO_KEEP_0__ is omitted, targets the active webview.
executeScript	Injects JavaScript code into the InAppBrowser window. When code is omitted, targets the active webview. id ditinggalkan, dieksekusi di semua webview yang terbuka.
postMessage	Mengirimkan suatu event ke webview (browser dalam aplikasi). Dengarkan di halaman dengan window.addEventListener('messageFromNative', listenerFunc)The detail Isi payload harus dapat di-serialisasi ke dalam JSON. Ketika id ditinggalkan, mengirimkan ke semua webview yang terbuka.
takeScreenshot	Mengambil tangkapan layar webview saat ini sebagai screenshot PNG. Ketika id ditinggalkan, mengarahkan ke webview aktif.
setUrl	Mengatur URL webview. Ketika id ditinggalkan, mengarahkan ke webview aktif.
addListener	Dengarkan perubahan URL, hanya untuk webview yang terbuka.
addListener	Dengarkan 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	Fires ketika webview mengirimkan event kembali ke aplikasi. Gunakan window.mobileApp.postMessage(...) di halaman, dan pastikan payload dapat di serialisasi ke JSON.
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 saat memuat halaman.
addListener	Akan diaktifkan setelah penggunaan native download handling menyimpan file secara lokal. Aktifkan ini dengan handleDownloads: true ketika membuka webview.
addListener	Akan diaktifkan ketika penggunaan native download handling gagal. Aktifkan ini dengan handleDownloads: true ketika membuka webview.
addListener	Akan diaktifkan ketika halaman membuka popup/baru jendela. Gunakan id popup yang dikembalikan dengan executeScript, postMessage, show, hide, dan close.
addListener	Tangkap permintaan proxied yang di delegasikan oleh runtime native. Preferensi addProxyHandler() sebaliknya dari memanggil ini secara langsung.
addListener	Tangkap keluaran konsol JavaScript yang dihasilkan oleh halaman yang diatur. Aktifkan ini dengan captureConsoleLogs: true ketika membuka webview.
handleProxyRequest	Metode internal yang digunakan oleh addProxyHandler() untuk mengirimkan keputusan proxy kembali ke native. Forwardlah asal phase ketika menjawab manual proxyRequest pengguna.
removeAllListeners	Hapus semua listener untuk plugin ini.
reload	Muat ulang halaman web saat ini.
updateDimensions	Perbarui dimensi webview. Memungkinkan mengubah ukuran dan posisi webview pada waktu runtime. Ketika id terlepas, mengarah ke webview aktif.
setEnabledSafeTopMargin	Mengatur jarak atas aman webview yang diaktifkan secara waktu pelaksanaan. Ketika id terlepas, mengarah ke webview aktif. Pada Web, metode ini adalah no-op dan menyelesaikan tanpa mengubah tata letak.
setEnabledSafeBottomMargin	Mengatur jarak bawah aman webview yang diaktifkan secara waktu pelaksanaan. Ketika id terlepas, mengarah ke webview aktif. Pada Web, metode ini adalah no-op dan menyelesaikan tanpa mengubah tata letak.
openSecureWindow	Membuka jendela OAuth2 yang aman. Pada web, kembalikan URL yang diarahkan melalui BroadcastChannel; pada mobile, daftarkan URI redirect kustom dalam 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 tombol tutup dan kontrol 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 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 Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, Mengambah atau Mengupdate Plugin untuk detail implementasi di Mengambah atau Mengupdate Plugin, dan Alternatif Plugin Perusahaan Ionic untuk alur kerja produk dalam Alternatif Plugin Perusahaan Ionic.