Widget aplikasi adalah tampilan aplikasi mini yang dapat Anda sematkan di aplikasi lain—seperti layar utama—dan menerima update berkala. Tampilan ini disebut sebagai widget di antarmuka pengguna, dan Anda dapat memublikasikannya dengan penyedia widget aplikasi (atau penyedia widget). Komponen aplikasi yang menampung widget lain disebut host widget aplikasi (atau host widget). Gambar 1 menunjukkan contoh widget musik:
Dokumen ini menjelaskan cara memublikasikan widget menggunakan penyedia widget. Untuk
detail tentang cara membuat AppWidgetHost Anda sendiri untuk menghosting
widget aplikasi, lihat Membangun host widget.
Untuk mengetahui informasi tentang cara mendesain widget, lihat Ringkasan widget aplikasi.
Komponen widget
Untuk membuat widget, Anda memerlukan komponen dasar berikut:
- Objek
AppWidgetProviderInfo - Menjelaskan metadata untuk widget, seperti tata letak widget, frekuensi update, dan class
AppWidgetProvider.AppWidgetProviderInfoditentukan dalam XML, seperti yang dijelaskan dalam dokumen ini. - Class
AppWidgetProvider - Menentukan metode dasar
yang memungkinkan Anda berinteraksi dengan widget secara terprogram. Melalui aplikasi ini, Anda
menerima siaran saat widget diupdate, diaktifkan, dinonaktifkan, atau
dihapus. Anda mendeklarasikan
AppWidgetProviderdalam manifes, lalu menerapkannya, seperti yang dijelaskan dalam dokumen ini. - Tata letak tampilan
- Menentukan tata letak awal untuk widget. Tata letak ditentukan dalam XML, seperti yang dijelaskan dalam dokumen ini.
Gambar 2 menunjukkan cara komponen ini sesuai dengan alur pemrosesan widget aplikasi secara keseluruhan.
Jika widget Anda memerlukan konfigurasi pengguna, terapkan aktivitas konfigurasi widget aplikasi. Aktivitas ini memungkinkan pengguna mengubah setelan widget—misalnya, zona waktu untuk widget jam.
- Mulai Android 12 (level API 31), Anda dapat memberikan konfigurasi default dan memungkinkan pengguna mengonfigurasi ulang widget nanti. Lihat Menggunakan konfigurasi default widget dan Memungkinkan pengguna mengonfigurasi ulang widget yang ditempatkan untuk mengetahui detail selengkapnya.
- Di Android 11 (level API 30) atau yang lebih rendah, aktivitas ini diluncurkan setiap kali pengguna menambahkan widget ke layar utama.
Kami juga merekomendasikan peningkatan berikut: tata letak widget yang fleksibel, peningkatan lain-lain, widget lanjutan, widget koleksi, dan membangun host widget.
Mendeklarasikan XML AppWidgetProviderInfo
Menentukan setelan metadata (seperti ukuran sel default, batasan pengubahan ukuran, dan frekuensi update) sama persis di seluruh widget berbasis Sekilas dan berbasis Tampilan tradisional.
Untuk mempelajari cara menentukan dan mengonfigurasi file XML metadata, lihat bagian Mendeklarasikan XML AppWidgetProviderInfo yang mengutamakan Compose dalam dokumentasi Glance.
Menggunakan class AppWidgetProvider untuk menangani siaran widget
Mekanisme penerima siaran, filter deklarasi manifes, dan loop peristiwa siklus proses platform disatukan di bawah platform. Dalam pengembangan
Compose-first, siaran ini diatur menggunakan wrapper
GlanceAppWidgetReceiver.
Untuk memahami cara mendaftarkan penerima di manifes dan menerapkan penggantian siklus proses yang kompatibel dengan Hilt, lihat Gunakan bagian class AppWidgetProvider untuk menangani siaran yang mengutamakan Compose dalam dokumentasi Glance.
Membuat tata letak widget
Anda harus menentukan tata letak awal untuk widget Anda dalam XML dan menyimpannya di direktori res/layout/ project. Lihat Pedoman desain untuk mengetahui detailnya.
Pembuatan tata letak widget cukup mudah jika Anda memahami
tata letak. Namun, perlu diketahui bahwa tata letak widget didasarkan pada
RemoteViews, yang tidak mendukung setiap jenis tata letak atau widget tampilan.
Anda tidak dapat menggunakan tampilan kustom atau subclass tampilan yang didukung oleh
RemoteViews.
RemoteViews juga mendukung ViewStub, yang merupakan View tidak terlihat berukuran nol
yang dapat Anda gunakan untuk meng-inflate resource tata letak secara lambat saat runtime.
Dukungan untuk perilaku stateful
Android 12 menambahkan dukungan untuk perilaku stateful dengan menggunakan komponen yang ada berikut:
Widget tetap stateless. Aplikasi Anda harus menyimpan status dan mendaftar peristiwa perubahan status.
Contoh kode berikut menunjukkan cara menerapkan komponen ini.
Kotlin
// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true)
// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2)
// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
R.id.my_checkbox,
RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent)
)
Java
// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true);
// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2);
// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
R.id.my_checkbox,
RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));
Sediakan dua tata letak: satu menargetkan perangkat yang menjalankan Android 12 atau yang lebih tinggi di res/layout-v31, dan yang lain menargetkan Android 11 atau yang lebih rendah di folder res/layout default.
Menerapkan sudut bulat
Menghitung radius proporsional luar dan dalam adalah hal yang standar dan umum. Dalam pengembangan yang mengutamakan Compose, hal ini dapat ditetapkan secara dinamis di Kotlin bersama dengan resource tema kustom.
Untuk menerapkan radius sudut atau menyiapkan gaya dinamis untuk perangkat Android lama, lihat bagian Menerapkan sudut bulat yang mengutamakan Compose dalam dokumentasi Glance.