@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 aplikasi Anda dapat ukur, sembunyikan, kirim pesan, skrip, proxy, dan lapis dengan UI Ionic.

Gunakan 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 antarmuka Ionic atau Capacitor di atas halaman browser yang hidup dengan toBack, sendToBack(), bringToFront(), transparentBackground, dan dispatchInputEvent().
• Buat browser layar setengah, sheet bawah, dan webview gambar dalam gambar dengan width, height, x, y, dan updateDimensions().
• Biarkan pengguna mengetuk aplikasi Capacitor di luar kerangka browser ukuran kustom pada Android dan iOS.
• Jalankan alur checkout, login, dukungan, atau perubahan akun tanpa penyimpanan situs yang berlangsung menggunakan persistWebViewData: false dan clearAllBrowsingData().
• Tahan beberapa instance browser yang dimuat dengan hidden, hide()dan show() sambil menjaga keadaan halaman.
• Integrasikan aplikasi web canggih yang memerlukan proxy permintaan, unggah file, download, kontrol popup, dukungan Google Pay, _blank pengaturan tautan, dan pesan aplikasi ke halaman.

Kemampuan Dasar

• open - Membuka URL di Chrome Custom Tabs pada Android atau SFSafariViewController - di iOS.
• openWebView - Membuka WebView native yang diatur dengan toolbar kustom, ukuran, navigasi native, pesan, skrip, proxy, download, popup, dan kontrol data.
• sendToBack / bringToFront - Menggeser browser yang diatur ke belakang atau di atas WebView host Capacitor.
• dispatchInputEvent - Mengalihkan peristiwa klik, sentuh, dan gulir ke browser yang berada di belakang UI aplikasi native.
• updateDimensions - Mengubah ukuran dan posisi WebView yang diatur tanpa memuat ulang halaman.
• hide / show - Mengaktifkan WebViews yang diatur sementara menghapus atau memulihkan presentasi native mereka.
• 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- Mengatur aturan proxy, dan event popup - Mendukung portal dokumen, aliran unggah, halaman pembayaran, dan aplikasi web terintegrasi.

- Aplikasi API Publik

- Metode	- Deskripsi
goBack	- Membalikkan ke sejarah WebView jika memungkinkan.
open	- Membuka url di jendela baru fullscreen, pada android menggunakan chrome custom tabs, pada ios menggunakan SFSafariViewController.
clearCookies	- Membersihkan cookie url Ketika id - Jika tidak ada, berlaku untuk semua webview yang terbuka.
clearAllCookies	Hapus semua cookie Ketika id Jika tidak ada, berlaku untuk semua webview terbuka.
clearCache	Hapus cache Ketika id Jika tidak ada, berlaku untuk semua webview terbuka.
clearAllBrowsingData	Menghapus cookie, cache, penyimpanan lokal, penyimpanan sesi, IndexedDB, dan data browsing lainnya dari penyimpanan default dan WebViews yang diatur.
getCookies	Dapatkan cookie untuk URL tertentu.
close	Tutup webview. Jika id tidak ada, tutup webview aktif.
hide	Sembunyikan webview tanpa menutupnya. Gunakan show() untuk mengembalikannya. Jika id tidak ada, sasar webview aktif.
show	Tampilkan kembali webview yang disembunyikan sebelumnya. Jika id tidak ada, sasar webview aktif.
sendToBack	Menggerakkan browser asli di balik Capacitor WebView host sehingga UI aplikasi dapat muncul di atasnya.
bringToFront	Mengembalikan browser yang berada di balik WebView host ke depan.
dispatchInputEvent	Mengirimkan input klik, sentuh, atau gulir ke browser yang diatur; koordinat relatif terhadap viewport browser.
openWebView	Membuka URL di dalam sebuah 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 dalam jendela InAppBrowser. Ketika __CAPGO_KEEP_1__ dihilangkan, dieksekusi di semua webview terbuka. id Mengirimkan event ke webview (browser dalam aplikasi). Dengarkan di halaman dengan __CAPGO_KEEP_2__. Isi __CAPGO_KEEP_3__ harus dapat diserialisasi ke JSON. Ketika __CAPGO_KEEP_1__ dihilangkan, disiarkan ke semua webview terbuka.
postMessage	Mengambil tangkapan layar webview saat ini sebagai gambar PNG. Ketika __CAPGO_KEEP_1__ dihilangkan, mengarah ke webview aktif. window.addEventListener('messageFromNative', listenerFunc)Menggerakkan browser asli di balik WebView host sehingga UI aplikasi dapat muncul di atasnya. detail Menggerakkan browser asli di balik WebView host sehingga UI aplikasi dapat muncul di atasnya. id Mengirimkan input klik, sentuh, atau gulir ke browser yang diatur; koordinat relatif terhadap viewport browser.
takeScreenshot	Membuka URL di dalam sebuah webview baru dengan toolbar dan kemampuan yang ditingkatkan, seperti akses kamera, akses file, mendengarkan event, menginjeksi JavaScript, komunikasi dua arah, dll. id Menginjeksi JavaScript ke dalam jendela InAppBrowser. Ketika dihilangkan, dieksekusi di semua webview terbuka.
setUrl	Mengatur URL dari tampilan web. Ketika id terlepas, mengarah ke tampilan web aktif.
addListener	Dengarkan perubahan URL, hanya untuk openWebView.
addListener	Dengarkan buttonNearDoneClick; isi payload berisi tampilan web id.
addListener	Dengarkan hanya klik tutup untuk openWebView.
addListener	Akan diaktifkan ketika pengguna mengklik tombol konfirmasi ketika peringatan diperlukan, bekerja dengan openWebView shareDisclaimer dan closeModal.
addListener	Akan diaktifkan ketika tampilan web mengirimkan event kembali ke aplikasi. Gunakan window.mobileApp.postMessage(...) dalam halaman, dan jaga isi payload dapat di serialisasi ke JSON.
addListener	Akan diaktifkan setiap kali layar tangkapan sederhana diambil dari plugin API, tombol tangkapan sederhana 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 asli menyimpan file secara lokal. Aktifkan fitur ini dengan handleDownloads: true ketika membuka webview.
addListener	Akan diaktifkan ketika pengelolaan download asli gagal. Aktifkan fitur ini dengan handleDownloads: true ketika membuka webview.
addListener	Akan diaktifkan setiap kali halaman membuka popup/jendela baru. Gunakan id popup yang dikembalikan dengan executeScript, postMessage, show, hide, dan close.
addListener	Dengarkan permintaan proxied yang diutus oleh runtime asli. Lebih baik addProxyHandler() dibandingkan dengan memanggilnya secara langsung.
addListener	Dengarkan keluaran konsol JavaScript yang dihasilkan oleh halaman yang diatur. Aktifkan fitur ini dengan captureConsoleLogs: true ketika membuka webview.
handleProxyRequest	Metode internal yang digunakan oleh addProxyHandler() untuk mengirimkan keputusan proxy kembali ke asli. Lanjutkan ke asli phase ketika menjawab manual proxyRequest pengendali.
removeAllListeners	Hapus semua pengendali untuk plugin ini.
reload	Muat ulang halaman web saat ini.
updateDimensions	Perbarui dimensi dari webview. Memungkinkan mengubah ukuran dan posisi webview pada saat runtime. Ketika id ditinggalkan kosong, mengarahkan ke webview aktif.
setEnabledSafeTopMargin	Menetapkan margin atas yang aman diaktifkan webview pada saat runtime. Ketika id ditinggalkan kosong, mengarahkan ke webview aktif. Pada Web, metode ini adalah no-op dan menyelesaikan tanpa mengubah tata letak.
setEnabledSafeBottomMargin	Menetapkan margin bawah yang aman diaktifkan webview pada saat runtime. Ketika id ditinggalkan kosong, mengarahkan 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 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 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, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin 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.