Membuat widget dasar

Mencoba cara Compose
Jetpack Compose adalah toolkit UI yang direkomendasikan untuk Android. Pelajari cara membuat widget menggunakan API bergaya Compose.

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 menyimpan widget lain disebut host widget aplikasi (atau host widget). Gambar 1 menunjukkan contoh widget musik:

Contoh widget musik
Gambar 1. Contoh widget musik.

Dokumen ini menjelaskan cara memublikasikan widget menggunakan penyedia widget. Untuk mengetahui 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. AppWidgetProviderInfo ditentukan dalam XML, seperti yang dijelaskan dalam dokumen ini.
Class AppWidgetProvider
Menentukan metode dasar yang memungkinkan Anda berinteraksi secara terprogram dengan widget. Melalui class ini, Anda akan menerima siaran saat widget diupdate, diaktifkan, dinonaktifkan, atau dihapus. Anda mendeklarasikan AppWidgetProvider dalam manifes, lalu mengimplementasikannya, 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 bagaimana komponen ini sesuai dengan alur pemrosesan widget aplikasi secara keseluruhan.

Alur pemrosesan widget aplikasi
Gambar 2. Alur pemrosesan widget aplikasi.

Jika widget Anda memerlukan konfigurasi pengguna, terapkan aktivitas konfigurasi widget aplikasi. Aktivitas ini memungkinkan pengguna mengubah setelan widget—misalnya, zona waktu untuk widget jam.

Kami juga merekomendasikan peningkatan berikut: tata letak widget fleksibel, berbagai peningkatan, widget lanjutan, widget koleksi, dan membuat host widget.

Mendeklarasikan XML AppWidgetProviderInfo

Menentukan setelan metadata (seperti ukuran sel default, batasan pengubahan ukuran, dan frekuensi update) sama persis di seluruh Tampilan tradisional dan widget berbasis Glance.

Untuk mempelajari cara menentukan dan mengonfigurasi file XML metadata, lihat bagian Deklarasikan XML AppWidgetProviderInfo Compose-first 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 yang mengutamakan Compose, siaran ini diorkestrasi menggunakan wrapper GlanceAppWidgetReceiver.

Untuk memahami cara mendaftarkan penerima dalam manifes dan menerapkan penggantian siklus proses yang kompatibel dengan Hilt, lihat bagian Menggunakan class AppWidgetProvider untuk menangani siaran yang mengutamakan Compose dalam dokumentasi Glance.

Membuat tata letak widget

Anda harus menentukan tata letak awal untuk widget di XML dan menyimpannya di direktori res/layout/ project. Baca Panduan desain untuk mengetahui detailnya.

Membuat tata letak widget sangatlah mudah jika Anda sudah 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 dan 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 menggunakan komponen yang ada berikut:

Widget tetap stateless. Aplikasi Anda harus menyimpan status dan mendaftar peristiwa perubahan status.

Contoh widget daftar belanja yang menampilkan perilaku stateful
Gambar 3. Contoh perilaku stateful.

Contoh kode berikut menunjukkan cara menerapkan komponen ini.

// 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 baru di res/layout-v31, dan yang lainnya menargetkan Android 11 atau yang lebih lama di folder res/layout default.

Menerapkan sudut bulat

Menghitung radius proporsional latar belakang luar dan dalam bersifat standar dan bersama. 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 membulat yang mengutamakan Compose dalam dokumentasi Glance.