@capgo/capacitor-inappbrowser
Ikhtisar
Bagian berjudul “Ringkasan”@capgo/capacitor-inappbrowser memberikan dua jalur browser untuk aplikasi Capacitor: open() untuk pengalaman browser sistem dan openWebView() untuk WebView native terkelola yang bisa diatur ukurannya, disembunyikan, dikirimi pesan, di-script, di-proxy, dan dilapisi Ionic UI oleh app Anda.
Gunakan saat halaman butuh lebih dari sekadar browser eksternal: alur OAuth dan checkout, portal dukungan tersemat, layar pembayaran, video call, portal dokumen, web app interaktif, atau alur apa pun yang butuh kontrol native di sekitar konten web live.
Nama package berubah.Kasus Penggunaan Umum
Bagian berjudul “Kasus Penggunaan Umum”- Tampilkan UI Ionic atau Capacitor di atas halaman browser live dengan
toBack,sendToBack(),bringToFront(),transparentBackground, dandispatchInputEvent(). - Buat browser layar parsial, bottom sheet, dan webview picture-in-picture dengan
width,height,x,y, danupdateDimensions(). - Biarkan pengguna tap app Capacitor di luar frame browser berukuran custom di Android dan iOS.
- Jalankan alur checkout, login, dukungan, atau pergantian akun tanpa penyimpanan situs web yang persisten menggunakan
persistWebViewData: falsedanclearAllBrowsingData(). - Jaga beberapa instans browser tetap dimuat dengan
hidden,hide(), danshow()sambil mempertahankan status halaman. - Sematkan aplikasi web canggih yang memerlukan proxy permintaan, upload file, download, kontrol popup, dukungan Google Pay,
_blankpenanganan link, dan pesan antar-aplikasi ke halaman.
Kemampuan Utama
Bagian berjudul “Kemampuan Utama”open- Membuka URL di Chrome Custom Tabs di Android atauSFSafariViewControllerdi iOS.openWebView- Membuka WebView native yang dikelola dengan toolbar kustom, ukuran, navigasi native, messaging, scripting, proxy, unduhan, popup, dan kontrol data.sendToBack/bringToFront- Memindahkan browser yang dikelola ke belakang atau di atas WebView host Capacitor.dispatchInputEvent- Meneruskan event klik, sentuh, dan gulir ke browser yang berada di belakang UI aplikasi native.updateDimensions- Mengubah ukuran dan posisi WebView yang dikelola tanpa memuat ulang halaman.hide/show- Menjaga WebView yang dikelola tetap termuat saat presentasi native-nya dihapus atau dipulihkan.postMessage/executeScript- Menghubungkan aplikasi Capacitor dengan JavaScript yang berjalan di dalam halaman yang dikelola.clearAllBrowsingData/persistWebViewData- Mengontrol cookie, cache, storage, IndexedDB, dan persistensi sesi.handleDownloads, aturan proxy, dan event popup - Mendukung portal dokumen, alur upload, halaman pembayaran, dan aplikasi web tertanam.
API Publik
Bagian berjudul “Public API”| Metode | Deskripsi |
|---|---|
goBack | Navigasi mundur dalam riwayat WebView jika memungkinkan. |
open | Buka url di jendela baru fullscreen; di android menggunakan chrome custom tabs, di ios menggunakan SFSafariViewController. |
clearCookies | Bersihkan cookies dari url Ketika id dihilangkan, berlaku untuk semua webviews yang terbuka. |
clearAllCookies | Bersihkan semua cookies Ketika id dihilangkan, berlaku untuk semua webviews yang terbuka. |
clearCache | Bersihkan cache Ketika id dihilangkan, berlaku untuk semua webviews yang terbuka. |
clearAllBrowsingData | Membersihkan cookies, cache, local storage, session storage, IndexedDB, dan data penelusuran lainnya dari default store dan WebViews yang dikelola. |
getCookies | Ambil cookies untuk URL tertentu. |
close | Tutup webview. Ketika id dihilangkan, webview yang aktif akan ditutup. |
hide | Sembunyikan webview tanpa menutupnya. Gunakan show() untuk menampilkannya kembali. Ketika id Jika dihilangkan, menargetkan webview yang aktif. |
show | Tampilkan webview yang sebelumnya disembunyikan. Ketika id Jika dihilangkan, menargetkan webview yang aktif. |
sendToBack | Pindahkan browser native ke belakang host WebView Capacitor agar UI aplikasi dapat muncul di atasnya. |
bringToFront | Pindahkan browser yang berada di belakang host WebView kembali ke depan. |
dispatchInputEvent | Kirim input klik, sentuh, atau gulir ke browser yang dikelola; koordinat relatif terhadap viewport browser. |
openWebView | Buka url di webview baru dengan toolbar dan kemampuan yang ditingkatkan, seperti akses kamera, akses file, event listener, injeksi javascript, komunikasi dua arah, dll. |
executeScript | Suntikkan code JavaScript ke jendela InAppBrowser. Ketika id dihilangkan, dieksekusi di semua webview yang terbuka. |
postMessage | Kirim event ke webview (in-app browser). Dengarkan di halaman dengan window.addEventListener('messageFromNative', listenerFunc). detail payload harus dapat diserialisasi ke JSON. Ketika id dihilangkan, akan broadcast ke semua webview yang terbuka. |
takeScreenshot | Mengambil screenshot viewport webview saat ini dalam format PNG. Saat id Jika dihilangkan, menargetkan webview yang aktif. |
setUrl | Mengatur URL webview. Saat id Jika dihilangkan, menargetkan webview yang aktif. |
addListener | Dengarkan perubahan URL, hanya untuk openWebView. |
addListener | Pantau saat buttonNearDoneClick; payload berisi webview id. |
addListener | Dengarkan klik tutup hanya untuk openWebView. |
addListener | Akan dipicu saat user klik tombol konfirmasi jika disclaimer diperlukan, bekerja dengan openWebView shareDisclaimer dan closeModal. |
addListener | Dipicu saat webview mengirim event kembali ke app. Gunakan window.mobileApp.postMessage(...) di dalam halaman, dan pastikan payload bersifat JSON-serializable. |
addListener | Akan dipicu setiap kali tangkapan layar diambil melalui plugin API, tombol screenshot bawaan, atau bridge JavaScript yang disuntikkan. |
addListener | Akan dipicu saat halaman dimuat. |
addListener | Akan dipicu saat terjadi error pemuatan halaman. |
addListener | Akan dipicu setelah native download handling menyimpan file secara lokal. Aktifkan ini dengan handleDownloads: true saat membuka webview. |
addListener | Akan dipicu saat native download handling gagal. Aktifkan ini dengan handleDownloads: true saat membuka webview. |
addListener | Akan dipicu setiap kali halaman membuka popup/jendela baru. Gunakan popup id yang dikembalikan dengan executeScript, postMessage, show, hide, dan close. |
addListener | Dengarkan request yang di-proxy dan didelegasikan oleh native runtime. Sebaiknya gunakan addProxyHandler() daripada memanggil ini secara langsung. |
addListener | Dengarkan output console JavaScript dari halaman yang dikelola. Aktifkan ini dengan captureConsoleLogs: true saat membuka webview. |
handleProxyRequest | Metode internal yang digunakan oleh addProxyHandler() untuk mengirim keputusan proxy kembali ke native. Teruskan phase saat membalas manual proxyRequest listener lama. |
removeAllListeners | Hapus semua listener plugin ini. |
reload | Muat ulang halaman web saat ini. |
updateDimensions | Perbarui dimensi webview. Mengizinkan perubahan ukuran dan posisi webview saat runtime. Saat id Jika dihilangkan, menargetkan webview yang aktif. |
setEnabledSafeTopMargin | Mengatur margin atas aman yang diaktifkan pada webview saat runtime. Ketika id dihapus, menargetkan webview aktif. Di Web, metode ini tidak melakukan apa-apa dan menyelesaikan tanpa mengubah layout. |
setEnabledSafeBottomMargin | Mengatur margin bawah aman yang diaktifkan untuk webview saat runtime. Ketika id dihapus, menargetkan webview aktif. Di Web, metode ini tidak melakukan apa-apa dan menyelesaikan tanpa mengubah layout. |
openSecureWindow | Membuka jendela OAuth2 yang aman. Di web, kembalikan URL yang dialihkan melalui BroadcastChannel; di mobile, daftarkan URI redirect kustom di konfigurasi aplikasi Anda. Lihat panduan getting-started untuk contoh lengkap HTML, Info.plist, dan AndroidManifest. |
Nilai Referensi
Bagian berjudul “Nilai Referensi”Gunakan nilai-nilai ini dengan opsi toolbar saat membuka in-app browser atau WebView.
Jenis Toolbar
Bagian berjudul “Jenis Toolbar”| Nilai | Pengguna akan menemukan |
|---|---|
activity | Toolbar sederhana dengan kontrol tutup dan bagikan. |
compact | Toolbar sederhana dengan kontrol tutup. |
navigation | Toolbar navigasi lengkap dengan kontrol mundur dan maju. |
blank | Tanpa toolbar. |
Sumber Kebenaran
Bagian berjudul “Sumber Kebenaran”Referensi ini disinkronkan dari src/definitions.ts di capacitor-inappbrowser.
Lanjutkan dari @capgo/capacitor-inappbrowser
Bagian berjudul “Lanjutkan dari @capgo/capacitor-inappbrowser”Jika Anda menggunakan @capgo/capacitor-inappbrowser untuk merencanakan pekerjaan plugin native, hubungkan dengan Menggunakan @capgo/capacitor-inappbrowser untuk kemampuan native saat menggunakan @capgo/capacitor-inappbrowser, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi pada Capacitor Plugins oleh Capgo Menambahkan atau Memperbarui Plugin untuk detail implementasi di Menambahkan atau Memperbarui Plugin, dan Alternatif Plugin Ionic Enterprise untuk alur kerja produk dalam Alternatif Plugin Ionic Enterprise.