Menambahkan daftar yang dapat di-scroll

1. Sebelum memulai

Dalam codelab ini, Anda akan mempelajari cara membuat daftar yang dapat di-scroll di aplikasi menggunakan Jetpack Compose.

Anda akan mengerjakan aplikasi Affirmations, yang menampilkan daftar afirmasi yang dipasangkan dengan gambar indah untuk membawa hal positif ke hari Anda!

Data sudah ada, Anda hanya perlu mengambil data tersebut dan menampilkannya di UI.

Prasyarat

• Pemahaman tentang Daftar di Kotlin
• Pengalaman membuat tata letak dengan Jetpack Compose
• Pengalaman menjalankan aplikasi di perangkat atau emulator

Yang akan Anda pelajari

• Cara membuat kartu Desain Material menggunakan Jetpack Compose
• Cara membuat daftar yang dapat di-scroll menggunakan Jetpack Compose

Yang akan Anda bangun

• Anda akan mengambil aplikasi yang sudah ada dan menambahkan daftar yang dapat di-scroll ke UI

Produk jadi akan terlihat seperti ini:

Yang akan Anda butuhkan

• Komputer dengan akses internet, browser web, dan Android Studio
• Akses ke GitHub

Mendownload kode awal

Di Android Studio, buka folder basic-android-kotlin-compose-training-affirmations.

URL kode awal:

https://github.com/google-developer-training/basic-android-kotlin-compose-training-affirmations/tree/starter

Nama cabang dengan kode awal: starter

1. Buka halaman repositori GitHub yang disediakan untuk project.
2. Pastikan nama cabang cocok dengan nama cabang yang ditentukan dalam codelab. Misalnya, dalam screenshot berikut, nama cabang adalah main (utama).

3. Di halaman GitHub project, klik tombol Code yang akan menampilkan pop-up.

4. Pada pop-up, klik tombol Download ZIP untuk menyimpan project di komputer. Tunggu download selesai.
5. Temukan file di komputer Anda (mungkin di folder Downloads).
6. Klik dua kali pada file ZIP untuk mengekstraknya. Tindakan ini akan membuat folder baru yang berisi file project.

Membuka project di Android Studio

1. Mulai Android Studio.
2. Di jendela Welcome to Android Studio, klik Open.

Catatan: Jika Android Studio sudah terbuka, pilih opsi menu File > Open.

3. Di file browser, buka lokasi folder project yang telah diekstrak (kemungkinan ada di folder Downloads).
4. Klik dua kali pada folder project tersebut.
5. Tunggu Android Studio membuka project.
6. Klik tombol Run untuk membangun dan menjalankan aplikasi. Pastikan aplikasi dibangun seperti yang diharapkan.

2. Membuat class data item daftar

Membuat class data untuk Affirmation

Di aplikasi Android, daftar terdiri dari item daftar. Untuk data tunggal, ini bisa berupa hal sederhana seperti string atau bilangan bulat. Untuk item daftar yang memiliki beberapa data, seperti gambar dan teks, Anda memerlukan class yang berisi semua properti ini. Class data adalah jenis class yang hanya berisi properti. Class tersebut dapat menyediakan beberapa metode utilitas agar berfungsi dengan properti tersebut.

1. Buat paket baru di bagian com.example.affirmations.

Namai paket baru tersebut dengan model. Paket model akan berisi model data yang akan direpresentasikan oleh class data. Class data tersebut akan terdiri dari properti yang mewakili informasi yang relevan dengan yang akan disebut "Affirmation", yang akan terdiri dari resource string dan resource gambar. Paket adalah direktori yang berisi beberapa class dan bahkan direktori lainnya.

2. Buat class baru di paket com.example.affirmations.model.

Namai class baru tersebut dengan Affirmation dan jadikan Data Class.

3. Setiap Affirmation terdiri dari satu gambar dan satu string. Buat dua properti val di class data Affirmation. Salah satunya harus disebut stringResourceId dan yang lainnya imageResourceId. Keduanya harus berupa bilangan bulat.

Affirmation.kt

data class Affirmation(
   val stringResourceId: Int,
   val imageResourceId: Int
)

4. Beri tag pada properti stringResourceId dengan anotasi @StringRes dan beri tag imageResourceId dengan @DrawableRes. stringResourceId mewakili ID untuk teks afirmasi yang disimpan di resource string. imageResourceId mewakili ID untuk gambar afirmasi yang disimpan di resource drawable.

Affirmation.kt

data class Affirmation(
   @StringRes val stringResourceId: Int,
   @DrawableRes val imageResourceId: Int
)

5. Sekarang, buka file Datasource.kt di paket com.example.affirmations.data dan hapus tanda komentar pada konten class Datasource.

Datasource.kt

class Datasource() {
   fun loadAffirmations(): List<Affirmation> {
       return listOf<Affirmation>(
           Affirmation(R.string.affirmation1, R.drawable.image1),
           Affirmation(R.string.affirmation2, R.drawable.image2),
           Affirmation(R.string.affirmation3, R.drawable.image3),
           Affirmation(R.string.affirmation4, R.drawable.image4),
           Affirmation(R.string.affirmation5, R.drawable.image5),
           Affirmation(R.string.affirmation6, R.drawable.image6),
           Affirmation(R.string.affirmation7, R.drawable.image7),
           Affirmation(R.string.affirmation8, R.drawable.image8),
           Affirmation(R.string.affirmation9, R.drawable.image9),
           Affirmation(R.string.affirmation10, R.drawable.image10))
   }
}

Catatan: Metode loadAffirmations() mengumpulkan semua data yang diberikan dalam kode awal dan menampilkannya sebagai daftar. Anda akan menggunakannya nanti untuk membuat daftar yang dapat di-scroll.

3. Menambahkan daftar ke aplikasi

Membuat kartu item daftar

Aplikasi ini dimaksudkan untuk menampilkan daftar afirmasi. Langkah pertama dalam mengonfigurasi UI untuk menampilkan daftar adalah membuat item daftar. Setiap item afirmasi terdiri dari gambar dan string. Data untuk setiap item ini dilengkapi dengan kode awal, dan Anda akan membuat komponen UI untuk menampilkan item tersebut.

Item akan terdiri dari composable Card, yang berisi Image dan composable Text. Di Compose, Card adalah platform yang menampilkan konten dan tindakan dalam satu penampung. Kartu Affirmation akan terlihat seperti ini:

Kartu ini menampilkan gambar dengan teks di bawahnya. Tata letak vertikal ini dapat dibuat menggunakan composable Column yang digabungkan dalam composable Card. Anda dapat mencobanya sendiri, atau ikuti langkah-langkah di bawah untuk melakukannya.

1. Buka file MainActivity.kt.

2. Buat metode baru di bawah metode AffirmationApp(), yang disebut AffirmationCard(), dan anotasikan dengan anotasi @Composable.

MainActivity.kt

@Composable
fun AffirmationApp() {
   val context = LocalContext.current
   AffirmationsTheme {
    
   }
}

@Composable
fun AffirmationCard() {
  
}

3. Edit tanda tangan metode untuk mengambil objek Affirmation sebagai parameter. Objek Affirmation berasal dari paket model.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation) {
  
}

4. Tambahkan parameter modifier ke tanda tangan. Setel nilai default Modifier untuk parameter.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation, modifier: Modifier = Modifier) {
  
}

Catatan: Sebaiknya teruskan pengubah ke setiap composable dan setel ke nilai default.

5. Di dalam metode AffirmationCard, panggil composable Card. Teruskan parameter berikut: modifier dan elevation. Teruskan objek Modifier dengan atribut padding yang disetel ke 8.dp untuk parameter modifier. Teruskan nilai 4.dp untuk elevation. Properti elevation akan dibahas secara lebih mendetail nanti.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation, modifier: Modifier = Modifier) {Card(modifier = modifier.padding(8.dp), elevation = 4.dp) {
  }
}

6. Tambahkan composable Column di dalam composable Card. Item dalam composable Column menyusun dirinya sendiri secara vertikal di UI. Hal ini memungkinkan Anda menempatkan gambar di atas teks terkait. Sebaliknya, composable Row mengatur item yang ditampung secara horizontal.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation, modifier: Modifier = Modifier) {
  Card(modifier = modifier.padding(8.dp), elevation = 4.dp) {
    Column {
    }
  }
}

7. Tambahkan composable Image di dalam isi lambda dari composable Column. Ingat kembali bahwa composable Image selalu memerlukan resource untuk ditampilkan, dan contentDescription. Resource ini harus berupa painterResource yang diteruskan ke parameter painter. Metode painterResource akan memuat vektor drawable atau format aset raster seperti PNG. Selain itu, teruskan stringResource untuk parameter contentDescription.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation, modifier: Modifier = Modifier) {
  Card(modifier = Modifier.padding(8.dp), elevation = 4.dp) {
    Column {
      Image(
        painter = painterResource(affirmation.imageResourceId),
        contentDescription = stringResource(affirmation.stringResourceId)
      )
    }
  }
}

8. Selain parameter painter dan contentDescription, teruskan modifier dan contentScale. contentScale menentukan cara gambar harus diskalakan dan ditampilkan. Objek Modifier harus memiliki atribut fillMaxWidth yang disetel dan tinggi 194.dp. contentScale harus ContentScale.Crop.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation, modifier: Modifier = Modifier) {
  Card(modifier = Modifier.padding(8.dp), elevation = 4.dp) {
    Column {
      Image(
        painter = painterResource(affirmation.imageResourceId),
        contentDescription = stringResource(affirmation.stringResourceId),
        modifier = Modifier
          .fillMaxWidth()
          .height(194.dp),
        contentScale = ContentScale.Crop
      )
    }
  }
}

9. Di dalam Column, buat composable Text setelah composable Image. Teruskan stringResource dari affirmation.stringResourceId ke parameter text, teruskan objek Modifier dengan atribut padding yang disetel ke 16.dp, dan setel tema teks dengan meneruskan MaterialTheme.typography.h6 ke parameter style.

MainActivity.kt

@Composable
fun AffirmationCard(affirmation: Affirmation, modifier: Modifier = Modifier) {
  Card(modifier = Modifier.padding(8.dp), elevation = 4.dp) {
    Column {
      Image(
        painter = painterResource(affirmation.imageResourceId),
        contentDescription = stringResource(affirmation.stringResourceId),
        modifier = Modifier
          .fillMaxWidth()
          .height(194.dp),
        contentScale = ContentScale.Crop
      )
      Text(
        text = stringResource(affirmation.stringResourceId),
        modifier = Modifier.padding(16.dp),
        style = MaterialTheme.typography.h6
      )
    }
  }
}

Pratinjau composable AffirmationCard

Kartu ini adalah inti dari UI untuk aplikasi Affirmations, dan Anda telah bekerja keras untuk membuatnya. Untuk memeriksa apakah kartu sudah benar, Anda dapat membuat composable yang dapat dilihat pratinjaunya tanpa meluncurkan seluruh aplikasi.

1. Buat metode pribadi bernama AffirmationCardPreview(). Anotasikan metode dengan @Preview dan @Composable.

MainActivity.kt

@Preview 
@Composable
private fun AffirmationCardPreview() {
}

2. Di dalam metode, panggil composable AffirmationCard, dan teruskan objek Affirmation baru dengan resource string R.string.affirmation1 dan resource drawable R.drawable.image1 yang diteruskan ke konstruktornya.

MainActivity.kt

@Preview 
@Composable
private fun AffirmationCardPreview() {
  AffirmationCard(Affirmation(R.string.affirmation1, R.drawable.image1))
}

3. Buka tab Split dan Anda akan melihat pratinjau AffirmationCard. Jika perlu, klik Build & Refresh di panel Design untuk menampilkan pratinjau.

Membuat daftar

Komponen item daftar adalah elemen penyusun daftar. Setelah item daftar dibuat, Anda dapat memanfaatkannya untuk membuat komponen daftar itu sendiri.

1. Buat metode yang disebut AffirmationList(), anotasikan dengan anotasi @Composable, dan deklarasikan List objek Affirmation sebagai parameter di tanda tangan metode.

MainActivity.kt

@Composable
private fun AffirmationList(affirmationList: List<Affirmation>) {
}

2. Deklarasikan objek modifier sebagai parameter dalam tanda tangan metode dengan nilai default Modifier.

MainActivity.kt

@Composable
private fun AffirmationList(affirmationList: List<Affirmation>, modifier: Modifier = Modifier) {
}

3. Di Jetpack Compose, daftar yang dapat di-scroll dapat dibuat menggunakan composable LazyColumn. Perbedaan antara LazyColumn dan Column adalah bahwa Column harus digunakan saat Anda memiliki sedikit item untuk ditampilkan, karena Compose memuat semuanya sekaligus. Column hanya dapat menyimpan composable dengan jumlah yang tetap atau telah ditentukan. LazyColumn dapat menambahkan konten sesuai keperluan, yang menjadikannya cocok untuk daftar panjang, terutama jika panjang daftar tidak diketahui. LazyColumn juga menyediakan scroll secara default, tanpa kode tambahan. Deklarasikan composable LazyColumn di dalam metode AffirmationList().

MainActivity.kt

@Composable
private fun AffirmationList(affirmationList: List<Affirmation>, modifier: Modifier = Modifier) {
  LazyColumn {
  }
}

4. Dalam isi lambda LazyColumn, panggil metode items() dan teruskan affirmationList. Metode items() adalah cara Anda menambahkan item ke LazyColumn. Metode ini agak unik untuk composable ini, dan bukan praktik umum untuk sebagian besar composable.

MainActivity.kt

@Composable
private fun AffirmationList(affirmationList: List<Affirmation>, modifier: Modifier = Modifier) {
  LazyColumn {
    items(affirmationList){
    }
  }
}

5. Panggilan ke metode items() memerlukan fungsi lambda. Dalam fungsi tersebut, tetapkan parameter affirmation yang mewakili satu item afirmasi dari affirmationList.

MainActivity.kt

@Composable
private fun AffirmationList(affirmationList: List<Affirmation>, modifier: Modifier = Modifier) {
  LazyColumn {
    items(affirmationList){ affirmation ->
    }
  }
}

6. Untuk setiap afirmasi dalam daftar, panggil composable AffirmationCard(), dan teruskan affirmation.

MainActivity.kt

@Composable
private fun AffirmationList(affirmationList: List<Affirmation>, modifier: Modifier = Modifier) {
  LazyColumn {
    items(affirmationList){ affirmation ->
      AffirmationCard(affirmation)
    }
  }
}

Menampilkan daftar

1. Di lambda, panggil composable AffirmationList, lalu teruskan DataSource().loadAffirmations() ke parameter affirmationList.

Catatan: Class DataSource ditemukan dalam paket data.

MainActivity.kt

@Composable
fun AffirmationApp() {
   AffirmationsTheme {
       Scaffold(
           content = {
               AffirmationList(affirmationList = Datasource().loadAffirmations())
           }
       )
   }
}

Jalankan aplikasi Affirmations di perangkat atau emulator dan lihat produk yang sudah selesai.

4. Mendapatkan kode solusi

Jika Anda ingin melihat kode solusi, lihat di GitHub.

URL kode solusi:

https://github.com/google-developer-training/basic-android-kotlin-compose-training-affirmations/tree/main

Nama cabang dengan kode solusi: main

1. Buka halaman repositori GitHub yang disediakan untuk project.
2. Pastikan nama cabang cocok dengan nama cabang yang ditentukan dalam codelab. Misalnya, dalam screenshot berikut, nama cabang adalah main (utama).

3. Di halaman GitHub project, klik tombol Code yang akan menampilkan pop-up.

4. Pada pop-up, klik tombol Download ZIP untuk menyimpan project di komputer. Tunggu download selesai.
5. Temukan file di komputer Anda (mungkin di folder Downloads).
6. Klik dua kali pada file ZIP untuk mengekstraknya. Tindakan ini akan membuat folder baru yang berisi file project.

Membuka project di Android Studio

1. Mulai Android Studio.
2. Di jendela Welcome to Android Studio, klik Open.

Catatan: Jika Android Studio sudah terbuka, pilih opsi menu File > Open.

3. Di file browser, buka lokasi folder project yang telah diekstrak (kemungkinan ada di folder Downloads).
4. Klik dua kali pada folder project tersebut.
5. Tunggu Android Studio membuka project.
6. Klik tombol Run untuk membangun dan menjalankan aplikasi. Pastikan aplikasi dibangun seperti yang diharapkan.

5. Kesimpulan

Anda sekarang tahu cara membuat kartu, item daftar, dan daftar yang dapat di-scroll menggunakan Jetpack Compose. Ingatlah bahwa ini hanyalah alat dasar untuk membuat daftar. Anda dapat menyalurkan kreativitas dan menyesuaikan item daftar sesuka hati.

Ringkasan

• Gunakan composable Card untuk membuat item daftar.
• Ubah UI yang ada dalam composable Card.
• Buat daftar yang dapat di-scroll menggunakan composable LazyColumn.
• Buat daftar menggunakan item daftar kustom.