Mem-build UI dengan Glance

Halaman ini menjelaskan cara menangani ukuran dan menyediakan tata letak yang fleksibel dan responsif dengan Glance.

Catatan: Lihat ResponsiveAppWidget.kt dan ScrollableAppWidget.kt untuk lebih memahami bagian berikut.

Gunakan Box, Column, dan Row

Glance memiliki tiga tata letak composable utama:

• Box: Menempatkan elemen di atas elemen lainnya. Ini diterjemahkan menjadi RelativeLayout.

• Column: Menempatkan elemen satu sama lain di sumbu vertikal. Ini diterjemahkan menjadi LinearLayout dengan orientasi vertikal.

• Row: Menempatkan elemen satu sama lain dalam sumbu horizontal. Diterjemahkan menjadi LinearLayout dengan orientasi horizontal.

Gambar 1. Contoh tata letak dengan Column, Row, dan Box.

Poin Penting: Glance memberikan pendekatan modern untuk mem-build widget aplikasi menggunakan Compose, tetapi dibatasi oleh batasan AppWidgets dan RemoteViews. Oleh karena itu, Glance menggunakan composable yang berbeda dari UI Jetpack Compose.

Setiap composable ini memungkinkan Anda menentukan perataan vertikal dan horizontal kontennya serta batasan lebar, tinggi, berat, atau padding menggunakan pengubah. Selain itu, setiap turunan dapat menentukan pengubahnya untuk mengubah ruang dan penempatan di dalam induk.

Contoh berikut menunjukkan cara membuat Row yang mendistribusikan turunannya secara merata secara horizontal, seperti yang terlihat pada Gambar 1:

Row(modifier = GlanceModifier.fillMaxWidth().padding(16.dp)) {
    val modifier = GlanceModifier.defaultWeight()
    Text("first", modifier)
    Text("second", modifier)
    Text("third", modifier)
}
GlanceSnippets.kt

Row mengisi lebar maksimum yang tersedia, dan karena setiap turunan memiliki bobot yang sama, turunan tersebut berbagi ruang yang tersedia secara merata. Anda dapat menentukan bobot, ukuran, padding, atau perataan yang berbeda untuk menyesuaikan tata letak dengan kebutuhan Anda.

Catatan: Glance menerjemahkan composablenya menjadi Views sebenarnya, menggunakan pengubah dan parameter yang ditentukan untuk membuat tampilan yang mendasarinya. Dengan demikian, konsep Android View yang sama (seperti bobot) berlaku saat mem-build composable tertentu dengan Glance.

Menggunakan tata letak yang dapat di-scroll

Cara lain untuk menyediakan konten responsif adalah dengan membuatnya dapat di-scroll. Hal ini dapat dilakukan dengan composable LazyColumn. Composable ini memungkinkan Anda menentukan kumpulan item yang akan ditampilkan di dalam penampung yang dapat di-scroll dalam widget aplikasi.

Cuplikan berikut menunjukkan berbagai cara untuk menentukan item di dalam LazyColumn.

Anda dapat memberikan jumlah item:

// Remember to import Glance Composables
// import androidx.glance.appwidget.layout.LazyColumn

LazyColumn {
    items(10) { index: Int ->
        Text(
            text = "Item $index",
            modifier = GlanceModifier.fillMaxWidth()
        )
    }
}
GlanceSnippets.kt

Berikan item individual:

LazyColumn {
    item {
        Text("First Item")
    }
    item {
        Text("Second Item")
    }
}
GlanceSnippets.kt

Berikan daftar atau array item:

LazyColumn {
    items(peopleNameList) { name ->
        Text(name)
    }
}
GlanceSnippets.kt

Anda juga dapat menggunakan kombinasi dari contoh sebelumnya:

LazyColumn {
    item {
        Text("Names:")
    }
    items(peopleNameList) { name ->
        Text(name)
    }

    // or in case you need the index:
    itemsIndexed(peopleNameList) { index, person ->
        Text("$person at index $index")
    }
}
GlanceSnippets.kt

Perhatikan bahwa cuplikan sebelumnya tidak menentukan itemId. Menentukan itemId akan membantu meningkatkan performa dan mempertahankan posisi scroll hingga daftar dan update appWidget dari Android 12 dan seterusnya (misalnya, saat menambahkan atau menghapus item dari daftar). Contoh berikut menunjukkan cara menentukan itemId:

items(items = peopleList, key = { person -> person.id }) { person ->
    Text(person.name)
}
GlanceSnippets.kt

Catatan: Sekilas menerjemahkan LazyColumn menjadi ListView yang sebenarnya dengan terjemahan item yang disediakan. Dengan demikian, batasan dan pembatasan yang sama untuk koleksi RemoteViews berlaku.

Menentukan SizeMode

Ukuran AppWidget dapat berbeda bergantung pada perangkat, pilihan pengguna, atau peluncur, sehingga penting untuk menyediakan tata letak yang fleksibel seperti yang dijelaskan di halaman Menyediakan tata letak widget yang fleksibel. Glance menyederhanakan hal ini dengan definisi SizeMode dan nilai LocalSize. Bagian berikut menjelaskan tiga mode tersebut.

SizeMode.Single

SizeMode.Single adalah mode default. Ini menunjukkan bahwa hanya satu jenis konten yang disediakan; yaitu, meskipun ukuran AppWidget yang tersedia berubah, ukuran konten tidak berubah.

class MyAppWidget : GlanceAppWidget() {

    override val sizeMode = SizeMode.Single

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // ...

        provideContent {
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        // Size will be the minimum size or resizable
        // size defined in the App Widget metadata
        val size = LocalSize.current
        // ...
    }
}
GlanceSnippets.kt

Saat menggunakan mode ini, pastikan bahwa:

• Nilai metadata ukuran minimum dan maksimum ditentukan dengan benar berdasarkan ukuran konten.
• Konten cukup fleksibel dalam rentang ukuran yang diharapkan.

Secara umum, Anda harus menggunakan mode ini saat:

a) AppWidget memiliki ukuran tetap, atau b) kontennya tidak berubah saat diubah ukurannya.

SizeMode.Responsive

Mode ini setara dengan menyediakan tata letak responsif, yang memungkinkan GlanceAppWidget menentukan kumpulan tata letak responsif yang dibatasi oleh ukuran tertentu. Untuk setiap ukuran yang ditentukan, konten akan dibuat dan dipetakan ke ukuran tertentu saat AppWidget dibuat atau diupdate. Selanjutnya, sistem akan memilih yang paling sesuai berdasarkan ukuran yang tersedia.

Catatan: Ukuran pemasangan terbaik adalah salah satu dari DpSize yang disediakan dan sesuai dengan kotak pembatas yang tersedia dengan distorsi minimal. Jika tidak ada yang cocok, ukuran terkecil akan digunakan.

Misalnya, di AppWidget tujuan kita, Anda dapat menentukan tiga ukuran dan kontennya:

class MyAppWidget : GlanceAppWidget() {

    companion object {
        private val SMALL_SQUARE = DpSize(100.dp, 100.dp)
        private val HORIZONTAL_RECTANGLE = DpSize(250.dp, 100.dp)
        private val BIG_SQUARE = DpSize(250.dp, 250.dp)
    }

    override val sizeMode = SizeMode.Responsive(
        setOf(
            SMALL_SQUARE,
            HORIZONTAL_RECTANGLE,
            BIG_SQUARE
        )
    )

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // ...

        provideContent {
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        // Size will be one of the sizes defined above.
        val size = LocalSize.current
        Column {
            if (size.height >= BIG_SQUARE.height) {
                Text(text = "Where to?", modifier = GlanceModifier.padding(12.dp))
            }
            Row(horizontalAlignment = Alignment.CenterHorizontally) {
                Button()
                Button()
                if (size.width >= HORIZONTAL_RECTANGLE.width) {
                    Button("School")
                }
            }
            if (size.height >= BIG_SQUARE.height) {
                Text(text = "provided by X")
            }
        }
    }
}
GlanceSnippets.kt

Pada contoh sebelumnya, metode provideContent dipanggil tiga kali dan dipetakan ke ukuran yang ditentukan.

• Pada panggilan pertama, ukuran bernilai 100x100. Konten tersebut tidak menyertakan tombol tambahan, maupun teks atas dan bawah.
• Dalam panggilan kedua, ukuran bernilai 250x100. Konten tersebut menyertakan tombol tambahan, tetapi bukan teks atas dan bawah.
• Pada panggilan ketiga, ukuran bernilai 250x250. Konten tersebut menyertakan tombol tambahan dan kedua teks.

SizeMode.Responsive adalah kombinasi dari dua mode lainnya, dan memungkinkan Anda menentukan konten responsif dalam batas yang telah ditentukan. Secara umum, mode ini berperforma lebih baik dan memungkinkan transisi yang lebih lancar saat AppWidget diubah ukurannya.

Catatan: Tata letak responsif diperkenalkan di Android 12. Sebelum Android 12, composable dipanggil untuk setiap ukuran tempat widget aplikasi dapat ditampilkan (serupa dengan SizeMode.Exact). Untuk setiap ukuran, tampilan terbaik akan dipilih, yaitu tampilan terbesar yang sesuai dengan ruang yang tersedia, atau yang terkecil jika tidak ada yang cocok.

Tabel berikut menunjukkan nilai ukuran, bergantung pada ukuran SizeMode dan AppWidget yang tersedia:

Ukuran yang tersedia	105 x 110	203 x 112	72 x 72	203 x 150
SizeMode.Single	110 x 110	110 x 110	110 x 110	110 x 110
SizeMode.Exact	105 x 110	203 x 112	72 x 72	203 x 150
SizeMode.Responsive	80 x 100	80 x 100	80 x 100	150 x 120
* Nilai persisnya hanya untuk tujuan demo.

SizeMode.Exact

SizeMode.Exact setara dengan menyediakan tata letak yang tepat, yang meminta konten GlanceAppWidget setiap kali ukuran AppWidget yang tersedia berubah (misalnya, saat pengguna mengubah ukuran AppWidget di layar utama).

Misalnya, di widget tujuan, tombol tambahan dapat ditambahkan jika lebar yang tersedia lebih besar dari nilai tertentu.

class MyAppWidget : GlanceAppWidget() {

    override val sizeMode = SizeMode.Exact

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // ...

        provideContent {
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        // Size will be the size of the AppWidget
        val size = LocalSize.current
        Column {
            Text(text = "Where to?", modifier = GlanceModifier.padding(12.dp))
            Row(horizontalAlignment = Alignment.CenterHorizontally) {
                Button()
                Button()
                if (size.width > 250.dp) {
                    Button("School")
                }
            }
        }
    }
}
GlanceSnippets.kt

Mode ini memberikan fleksibilitas lebih dibandingkan yang lain, tetapi memiliki beberapa peringatan:

• AppWidget harus dibuat ulang sepenuhnya setiap kali ukuran berubah. Hal ini dapat menyebabkan masalah performa dan lompatan UI jika konten bersifat kompleks.
• Ukuran yang tersedia mungkin berbeda bergantung pada implementasi peluncur. Misalnya, jika peluncur tidak menyediakan daftar ukuran, ukuran minimum yang memungkinkan akan digunakan.
• Di perangkat pra-Android 12, logika penghitungan ukuran mungkin tidak berfungsi di semua situasi.

Secara umum, Anda harus menggunakan mode ini jika SizeMode.Responsive tidak dapat digunakan (artinya, sekumpulan kecil tata letak responsif tidak memungkinkan).

Mengakses resource

Gunakan LocalContext.current untuk mengakses resource Android apa pun, seperti ditunjukkan pada contoh berikut:

LocalContext.current.getString(R.string.glance_title)
GlanceSnippets.kt

Sebaiknya berikan ID resource secara langsung untuk mengurangi ukuran objek RemoteViews akhir dan untuk mengaktifkan resource dinamis, seperti warna dinamis.

Composable dan metode menerima resource menggunakan "penyedia", seperti ImageProvider, atau menggunakan metode overload seperti GlanceModifier.background(R.color.blue). Contoh:

Column(
    modifier = GlanceModifier.background(R.color.default_widget_background)
) { /**...*/ }

Image(
    provider = ImageProvider(R.drawable.ic_logo),
    contentDescription = "My image",
)
GlanceSnippets.kt

Menambahkan tombol majemuk

Tombol gabungan diperkenalkan di Android 12. Glance mendukung kompatibilitas mundur untuk jenis tombol compound berikut:

• Switch
• CheckBox
• RadioButton

Setiap tombol majemuk ini menampilkan tampilan yang dapat diklik yang mewakili status "dicentang".

var isApplesChecked by remember { mutableStateOf(false) }
var isEnabledSwitched by remember { mutableStateOf(false) }
var isRadioChecked by remember { mutableStateOf(0) }

CheckBox(
    checked = isApplesChecked,
    onCheckedChange = { isApplesChecked = !isApplesChecked },
    text = "Apples"
)

Switch(
    checked = isEnabledSwitched,
    onCheckedChange = { isEnabledSwitched = !isEnabledSwitched },
    text = "Enabled"
)

RadioButton(
    checked = isRadioChecked == 1,
    onClick = { isRadioChecked = 1 },
    text = "Checked"
)
GlanceSnippets.kt

Saat status berubah, lambda yang disediakan akan dipicu. Anda dapat menyimpan status pemeriksaan, seperti ditunjukkan pada contoh berikut:

class MyAppWidget : GlanceAppWidget() {

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        val myRepository = MyRepository.getInstance()

        provideContent {
            val scope = rememberCoroutineScope()

            val saveApple: (Boolean) -> Unit =
                { scope.launch { myRepository.saveApple(it) } }
            MyContent(saveApple)
        }
    }

    @Composable
    private fun MyContent(saveApple: (Boolean) -> Unit) {

        var isAppleChecked by remember { mutableStateOf(false) }

        Button(
            text = "Save",
            onClick = { saveApple(isAppleChecked) }
        )
    }
}
GlanceSnippets.kt

Anda juga dapat memberikan atribut colors ke CheckBox, Switch, dan RadioButton untuk menyesuaikan warnanya:

CheckBox(
    // ...
    colors = CheckboxDefaults.colors(
        checkedColor = ColorProvider(day = colorAccentDay, night = colorAccentNight),
        uncheckedColor = ColorProvider(day = Color.DarkGray, night = Color.LightGray)
    ),
    checked = isChecked,
    onCheckedChange = { isChecked = !isChecked }
)

Switch(
    // ...
    colors = SwitchDefaults.colors(
        checkedThumbColor = ColorProvider(day = Color.Red, night = Color.Cyan),
        uncheckedThumbColor = ColorProvider(day = Color.Green, night = Color.Magenta),
        checkedTrackColor = ColorProvider(day = Color.Blue, night = Color.Yellow),
        uncheckedTrackColor = ColorProvider(day = Color.Magenta, night = Color.Green)
    ),
    checked = isChecked,
    onCheckedChange = { isChecked = !isChecked },
    text = "Enabled"
)

RadioButton(
    // ...
    colors = RadioButtonDefaults.colors(
        checkedColor = ColorProvider(day = Color.Cyan, night = Color.Yellow),
        uncheckedColor = ColorProvider(day = Color.Red, night = Color.Blue)
    ),

)
GlanceSnippets.kt

Catatan: Lihat contoh CompoundButtonAppWidget.kt untuk contoh yang lebih detail.