@capgo/capacitor-widget-kit

Pendahuluan

@capgo/capacitor-widget-kit memberikan aplikasi Capacitor dua cara untuk mengemudikan widget dan Aktivitas Hidup:

• SVG template activities: definisikan permukaan WidgetKit sebagai SVG, switch frame yang dinamis dari sentuhan, jalankan timer pause/play, ubah JSON state, dan koleksi event aksi di aplikasi.
• Sesi widget penuh-native: simpan UI widget sepenuhnya di Swift/Kotlin/Java sementara Capacitor mengontrol state JSON bersama dan pesan aplikasi-ke-widget atau widget-ke-aplikasi.

Pakailah template SVG ketika widget dapat dirender dari string SVG yang terpecahkan. Pakailah sesi widget penuh-native ketika widget memerlukan UI native yang disesuaikan tetapi masih harus memulai, menghentikan, sinkronisasi state, atau meminta aplikasi untuk menyelesaikan pekerjaan asinkron.

Demo

Alur Template Widget

Pilih Mode

Mode	Terbaik untuk	API Utama
Aktivitas Template SVG	Aktivitas Langsung atau permukaan widget yang menampilkan hasil output SVG	startTemplateActivity, performTemplateAction, listTemplateEvents
Sesi Widget Penuh-Native	Widget yang dirender secara native yang memerlukan state bersama dan pekerjaan async	startWidgetSession, updateWidgetSession, sendWidgetMessage

Kedua mode dapat hidup di aplikasi yang sama. Misalnya, aplikasi olahraga dapat menggunakan SVG Live Activity untuk kontrol frame/timer cepat dan widget penuh-native sesi untuk widget layar utama dengan tata letak native yang lebih kaya.

Kemampuan Template SVG

bernama SVG varian seperti

• frames , atau summary, timerswitch, toggle, atau melalui frame setelah aksi hotspot. details.
• frameMutations mulai, pause, lanjutkan, toggle, reset, stop, atau ubah durasi timer.
• timerMutations update status JSON menggunakan nilai literal, template, tanggal, peningkatan, toggle, atau operasi hapus.
• patches peta area sentuh ke identifikasi aksi.
• hotspots mengizinkan aplikasi memproses aksi asal widget kemudian.
• listTemplateEvents Runtime memecahkan tempat-tempat seperti

__CAPGO_KEEP_0__ {{state.title}}, {{timers.rest.remainingText}}dan {{meta.template.kind}} sebelum jembatan asli kembali mengembalikan permukaan untuk rendering.

Penggunaan Jembatan Asli Penuh

Session penuh-asli adalah untuk widget yang mengrender UI mereka sendiri secara asli:

• startWidgetSession membuat status dan metadata bersama untuk widget native code.
• updateWidgetSession menggabungkan atau menggantikan status dan menandai sesi aktif lagi.
• stopWidgetSession merekam status akhir dan menandai sesi berhenti.
• sendWidgetMessage mengantre pekerjaan aplikasi-ke-widget atau widget-ke-aplikasi.
• acknowledgeWidgetMessages menandai pesan sebagai diterima.
• completeWidgetMessage menyimpan respons atau gagal untuk pekerjaan async.

Pesan-pesan adalah idempoten setelah selesai: mencoba ulang pesan yang selesai atau gagal kembali mengembalikan hasil yang ada bukan menggantinya.

Publik API

Metode	Deskripsi
areActivitiesSupported	Periksa apakah jembatan kegiatan template native dapat dijalankan pada perangkat saat ini.
startTemplateActivity	Simpan template SVG kegiatan dan mulai jembatan kegiatan Live Activity native.
updateTemplateActivity	Ganti definisi kegiatan, status, atau buka URL.
endTemplateActivity	Akhirkan kegiatan yang berjalan dan secara opsional simpan snapshot status terakhir.
performTemplateAction	Eksekusi patch deklaratif, mutasi frame, mutasi timer, dan pencatatan log event.
getTemplateActivity	Baca satu kegiatan template yang disimpan.
listTemplateActivities	Daftar semua kegiatan template yang disimpan.
listTemplateEvents	Baca event aksi yang dikeluarkan oleh aksi template.
acknowledgeTemplateEvents	Merkkan event template sebagai diproses.
startWidgetSession	Mulai sesi widget penuh-natip yang didukung oleh JSON bersama.
updateWidgetSession	Menggabungkan atau menggantikan state sesi widget penuh-natip.
stopWidgetSession	Berhenti sesi widget penuh-natip dan secara opsional menyimpan state akhir.
getWidgetSession	Baca satu sesi widget penuh-natip.
listWidgetSessions	Tampilkan setiap sesi widget penuh-natip.
sendWidgetMessage	Antrian pesan antara aplikasi dan widget natip code.
listWidgetMessages	Tampilkan pesan antrian jembatan.
acknowledgeWidgetMessages	Merkkan pesan jembatan sebagai diakui.
completeWidgetMessage	Mengakhiri atau gagal pesan jembatan async.
getPluginVersion	Kembalikan tanda versi implementasi platform.

Bagian-bagian Natip

Plugin ini juga mengirimkan bantuan asli untuk target widget:

• CapgoTemplateWidgetBridge mengatasi permukaan template SVG ke svg, frameId, hotspots, dan metadata.
• CapgoTemplateActionIntent menghubungkan tombol widget iOS interaktif ke aksi template.
• CapgoNativeWidgetBridge memuat sesi dan pesan penuh-asli dari widget native code.
• Bantuan template Android menyediakan perilaku penerima aksi dan jembatan widget yang sesuai.

Sumber Kebenaran

Referensi API disinkronkan dari src/definitions.ts di repositori plugin.

Teruskan dari @capgo/capacitor-widget-kit

Jika Anda menggunakan @capgo/capacitor-widget-kit untuk merencanakan otomatisasi CI/CD, hubungkannya dengan Menggunakan @capgo/capacitor-widget-kit untuk kemampuan asli dalam Menggunakan @capgo/capacitor-widget-kit, Capgo CI/CD untuk alur kerja produk dalam Capgo CI/CD, Capgo Pembangunan Asli untuk alur kerja produk dalam Capgo Pembangunan Asli, Capgo Integrasi untuk alur kerja produk dalam Capgo Integrasi, dan Integrasi CI/CD untuk detail implementasi di Integrasi CI/CD.