Transisi Elemen Bersama di Compose

Transisi elemen bersama adalah cara yang lancar untuk bertransisi di antara composable yang memiliki konten yang konsisten di antara keduanya. Fungsi ini sering digunakan untuk navigasi, yang memungkinkan Anda menghubungkan berbagai layar secara visual saat pengguna menavigasi di antara layar tersebut.

Misalnya, dalam video berikut, Anda dapat melihat gambar dan judul camilan dibagikan dari halaman listingan, ke halaman detail.

Gambar 1. Demo elemen bersama Jetsnack

Di Compose, ada beberapa API tingkat tinggi yang membantu Anda membuat elemen bersama:

• SharedTransitionLayout: Tata letak terluar yang diperlukan untuk menerapkan transisi elemen bersama. Class ini menyediakan SharedTransitionScope. Composable harus berada di SharedTransitionScope untuk menggunakan pengubah elemen bersama.
• Modifier.sharedElement(): Pengubah yang menandai composable yang harus dicocokkan dengan composable lain ke SharedTransitionScope.
• Modifier.sharedBounds(): Pengubah yang menandai ke SharedTransitionScope bahwa batas composable ini harus digunakan sebagai batas penampung untuk tempat transisi akan berlangsung. Berbeda dengan sharedElement(), sharedBounds() dirancang untuk konten yang berbeda secara visual.

Konsep penting saat membuat elemen bersama di Compose adalah cara kerjanya dengan overlay dan penyesuaian nilai. Lihat bagian pemangkasan dan overlay untuk mempelajari lebih lanjut topik penting ini.

Eksperimental: Dukungan elemen bersama tersedia dari Compose 1.7.0, dan bersifat eksperimental, API dapat berubah di masa mendatang. Laporkan bug di issuetracker.

Penggunaan Dasar

Transisi berikut akan dibuat di bagian ini, yang bertransisi dari item "daftar" yang lebih kecil, ke item mendetail yang lebih besar:

Gambar 2. Contoh dasar transisi elemen bersama antara dua composable.

Cara terbaik untuk menggunakan Modifier.sharedElement() adalah bersama dengan AnimatedContent, AnimatedVisibility, atau NavHost karena hal ini akan mengelola transisi antar-composable secara otomatis untuk Anda.

Titik awal adalah AnimatedContent dasar yang ada yang memiliki composable MainContent, dan DetailsContent sebelum menambahkan elemen bersama:

Gambar 3. Memulai AnimatedContent tanpa transisi elemen bersama.

1. Agar elemen bersama dapat dianimasikan di antara dua tata letak, lingkari composable AnimatedContent dengan SharedTransitionLayout. Cakupan dari SharedTransitionLayout dan AnimatedContent diteruskan ke MainContent dan DetailsContent:

   var showDetails by remember {
       mutableStateOf(false)
   }
   SharedTransitionLayout {
       AnimatedContent(
           showDetails,
           label = "basic_transition"
       ) { targetState ->
           if (!targetState) {
               MainContent(
                   onShowDetails = {
                       showDetails = true
                   },
                   animatedVisibilityScope = this@AnimatedContent,
                   sharedTransitionScope = this@SharedTransitionLayout
               )
           } else {
               DetailsContent(
                   onBack = {
                       showDetails = false
                   },
                   animatedVisibilityScope = this@AnimatedContent,
                   sharedTransitionScope = this@SharedTransitionLayout
               )
           }
       }
   }
   BasicSharedElementSnippets.kt

2. Tambahkan Modifier.sharedElement() ke rantai pengubah composable pada dua composable yang cocok. Buat objek SharedContentState dan ingat dengan rememberSharedContentState(). Objek SharedContentState menyimpan kunci unik yang menentukan elemen yang dibagikan. Berikan kunci unik untuk mengidentifikasi konten, dan gunakan rememberSharedContentState() agar item diingat. AnimatedContentScope diteruskan ke pengubah, yang digunakan untuk menkoordinasi animasi.

   @Composable
   private fun MainContent(
       onShowDetails: () -> Unit,
       modifier: Modifier = Modifier,
       sharedTransitionScope: SharedTransitionScope,
       animatedVisibilityScope: AnimatedVisibilityScope
   ) {
       Row(
           // ...
       ) {
           with(sharedTransitionScope) {
               Image(
                   painter = painterResource(id = R.drawable.cupcake),
                   contentDescription = "Cupcake",
                   modifier = Modifier
                       .sharedElement(
                           rememberSharedContentState(key = "image"),
                           animatedVisibilityScope = animatedVisibilityScope
                       )
                       .size(100.dp)
                       .clip(CircleShape),
                   contentScale = ContentScale.Crop
               )
               // ...
           }
       }
   }
   
   @Composable
   private fun DetailsContent(
       modifier: Modifier = Modifier,
       onBack: () -> Unit,
       sharedTransitionScope: SharedTransitionScope,
       animatedVisibilityScope: AnimatedVisibilityScope
   ) {
       Column(
           // ...
       ) {
           with(sharedTransitionScope) {
               Image(
                   painter = painterResource(id = R.drawable.cupcake),
                   contentDescription = "Cupcake",
                   modifier = Modifier
                       .sharedElement(
                           rememberSharedContentState(key = "image"),
                           animatedVisibilityScope = animatedVisibilityScope
                       )
                       .size(200.dp)
                       .clip(CircleShape),
                   contentScale = ContentScale.Crop
               )
               // ...
           }
       }
   }
   BasicSharedElementSnippets.kt

Untuk mendapatkan informasi tentang apakah kecocokan elemen bersama telah terjadi, ekstrak rememberSharedContentState() ke dalam variabel, dan buat kueri isMatchFound.

Penting: Urutan penempatan pengubah ini dalam rantai pengubah sangatlah penting. Masukkan apa pun yang tidak ingin Anda bagikan sebelum sharedElement() dalam rantai pengubah.

Yang menghasilkan animasi otomatis berikut:

Gambar 4. Contoh dasar transisi elemen bersama antara dua composable.

Anda mungkin melihat bahwa warna latar belakang dan ukuran seluruh penampung masih menggunakan setelan AnimatedContent default.

Batas bersama versus elemen bersama

Modifier.sharedBounds() mirip dengan Modifier.sharedElement(). Namun, pengubahnya berbeda dalam hal berikut:

• sharedBounds() ditujukan untuk konten yang berbeda secara visual, tetapi harus memiliki area yang sama di antara status, sedangkan sharedElement() mengharapkan konten tetap sama.
• Dengan sharedBounds(), konten yang masuk dan keluar layar akan terlihat selama transisi antara kedua status, sedangkan dengan sharedElement() hanya konten target yang akan dirender dalam batas transformasi. Modifier.sharedBounds() memiliki parameter enter dan exit untuk menentukan cara konten harus ditransisikan, mirip dengan cara kerja AnimatedContent.
• Kasus penggunaan yang paling umum untuk sharedBounds() adalah pola transformasi penampung, sedangkan untuk sharedElement(), contoh kasus penggunaannya adalah transisi hero.
• Saat menggunakan composable Text, sharedBounds() lebih disarankan untuk mendukung perubahan font seperti transisi antara perubahan cetak miring dan tebal atau warna.

Dari contoh sebelumnya, menambahkan Modifier.sharedBounds() ke Row dan Column dalam dua skenario yang berbeda akan memungkinkan kita berbagi batas kedua elemen tersebut dan melakukan animasi transisi, sehingga keduanya dapat berkembang satu sama lain:

@Composable
private fun MainContent(
    onShowDetails: () -> Unit,
    modifier: Modifier = Modifier,
    sharedTransitionScope: SharedTransitionScope,
    animatedVisibilityScope: AnimatedVisibilityScope
) {
    with(sharedTransitionScope) {
        Row(
            modifier = Modifier
                .padding(8.dp)
                .sharedBounds(
                    rememberSharedContentState(key = "bounds"),
                    animatedVisibilityScope = animatedVisibilityScope,
                    enter = fadeIn(),
                    exit = fadeOut(),
                    resizeMode = SharedTransitionScope.ResizeMode.ScaleToBounds()
                )
                // ...
        ) {
            // ...
        }
    }
}

@Composable
private fun DetailsContent(
    modifier: Modifier = Modifier,
    onBack: () -> Unit,
    sharedTransitionScope: SharedTransitionScope,
    animatedVisibilityScope: AnimatedVisibilityScope
) {
    with(sharedTransitionScope) {
        Column(
            modifier = Modifier
                .padding(top = 200.dp, start = 16.dp, end = 16.dp)
                .sharedBounds(
                    rememberSharedContentState(key = "bounds"),
                    animatedVisibilityScope = animatedVisibilityScope,
                    enter = fadeIn(),
                    exit = fadeOut(),
                    resizeMode = SharedTransitionScope.ResizeMode.ScaleToBounds()
                )
                // ...

        ) {
            // ...
        }
    }
}
SharedBoundsSnippets.kt

Gambar 5. Batas bersama antara dua composable.

Memahami Cakupan

Untuk menggunakan Modifier.sharedElement(), composable harus berada di SharedTransitionScope. Composable SharedTransitionLayout menyediakan SharedTransitionScope. Pastikan untuk menempatkannya di titik tingkat teratas yang sama dalam hierarki UI yang berisi elemen yang ingin Anda bagikan.

Umumnya, composable juga harus ditempatkan di dalam AnimatedVisibilityScope. Hal ini biasanya disediakan dengan menggunakan AnimatedContent untuk beralih antar-composable atau saat menggunakan AnimatedVisibility secara langsung, atau dengan fungsi composable NavHost, kecuali jika Anda mengelola visibilitas secara manual. Untuk menggunakan beberapa cakupan, simpan cakupan yang diperlukan di CompositionLocal, gunakan penerima konteks di Kotlin, atau teruskan cakupan sebagai parameter ke fungsi Anda.

Gunakan CompositionLocals dalam skenario saat Anda memiliki beberapa cakupan untuk dilacak, atau hierarki bertingkat dalam. CompositionLocal memungkinkan Anda memilih cakupan yang tepat untuk disimpan dan digunakan. Di sisi lain, saat Anda menggunakan penerima konteks, tata letak lain dalam hierarki Anda mungkin secara tidak sengaja mengganti cakupan yang disediakan. Misalnya, jika Anda memiliki beberapa AnimatedContent bertingkat, cakupan dapat diganti.

val LocalNavAnimatedVisibilityScope = compositionLocalOf<AnimatedVisibilityScope?> { null }
val LocalSharedTransitionScope = compositionLocalOf<SharedTransitionScope?> { null }

@Composable
private fun SharedElementScope_CompositionLocal() {
    // An example of how to use composition locals to pass around the shared transition scope, far down your UI tree.
    // ...
    SharedTransitionLayout {
        CompositionLocalProvider(
            LocalSharedTransitionScope provides this
        ) {
            // This could also be your top-level NavHost as this provides an AnimatedContentScope
            AnimatedContent(state, label = "Top level AnimatedContent") { targetState ->
                CompositionLocalProvider(LocalNavAnimatedVisibilityScope provides this) {
                    // Now we can access the scopes in any nested composables as follows:
                    val sharedTransitionScope = LocalSharedTransitionScope.current
                        ?: throw IllegalStateException("No SharedElementScope found")
                    val animatedVisibilityScope = LocalNavAnimatedVisibilityScope.current
                        ?: throw IllegalStateException("No AnimatedVisibility found")
                }
                // ...
            }
        }
    }
}
BasicSharedElementSnippets.kt

Atau, jika hierarki Anda tidak disusun bertingkat, Anda dapat meneruskan cakupan ke bawah sebagai parameter:

@Composable
fun MainContent(
    animatedVisibilityScope: AnimatedVisibilityScope,
    sharedTransitionScope: SharedTransitionScope
) {
}

@Composable
fun Details(
    animatedVisibilityScope: AnimatedVisibilityScope,
    sharedTransitionScope: SharedTransitionScope
) {
}
BasicSharedElementSnippets.kt

Elemen bersama dengan AnimatedVisibility

Contoh sebelumnya menunjukkan cara menggunakan elemen bersama dengan AnimatedContent, tetapi elemen bersama juga berfungsi dengan AnimatedVisibility.

Misalnya, dalam contoh petak lambat ini, setiap elemen digabungkan dalam AnimatedVisibility. Saat item diklik - konten memiliki efek visual seperti ditarik dari UI ke dalam komponen seperti dialog.

var selectedSnack by remember { mutableStateOf<Snack?>(null) }

SharedTransitionLayout(modifier = Modifier.fillMaxSize()) {
    LazyColumn(
        // ...
    ) {
        items(listSnacks) { snack ->
            AnimatedVisibility(
                visible = snack != selectedSnack,
                enter = fadeIn() + scaleIn(),
                exit = fadeOut() + scaleOut(),
                modifier = Modifier.animateItem()
            ) {
                Box(
                    modifier = Modifier
                        .sharedBounds(
                            sharedContentState = rememberSharedContentState(key = "${snack.name}-bounds"),
                            // Using the scope provided by AnimatedVisibility
                            animatedVisibilityScope = this,
                            clipInOverlayDuringTransition = OverlayClip(shapeForSharedElement)
                        )
                        .background(Color.White, shapeForSharedElement)
                        .clip(shapeForSharedElement)
                ) {
                    SnackContents(
                        snack = snack,
                        modifier = Modifier.sharedElement(
                            state = rememberSharedContentState(key = snack.name),
                            animatedVisibilityScope = this@AnimatedVisibility
                        ),
                        onClick = {
                            selectedSnack = snack
                        }
                    )
                }
            }
        }
    }
    // Contains matching AnimatedContent with sharedBounds modifiers.
    SnackEditDetails(
        snack = selectedSnack,
        onConfirmClick = {
            selectedSnack = null
        }
    )
}
AnimatedVisibilitySharedElementSnippets.kt

Gambar 6.Elemen bersama dengan AnimatedVisibility.

Pengurutan pengubah

Dengan Modifier.sharedElement() dan Modifier.sharedBounds(), urutan rantai pengubah Anda penting, seperti halnya Compose lainnya. Penempatan pengubah yang memengaruhi ukuran yang salah dapat menyebabkan lompatan visual yang tidak terduga selama pencocokan elemen bersama.

Misalnya, jika Anda menempatkan pengubah padding pada posisi yang berbeda pada dua elemen bersama, ada perbedaan visual dalam animasi.

var selectFirst by remember { mutableStateOf(true) }
val key = remember { Any() }
SharedTransitionLayout(
    Modifier
        .fillMaxSize()
        .padding(10.dp)
        .clickable {
            selectFirst = !selectFirst
        }
) {
    AnimatedContent(targetState = selectFirst, label = "AnimatedContent") { targetState ->
        if (targetState) {
            Box(
                Modifier
                    .padding(12.dp)
                    .sharedBounds(
                        rememberSharedContentState(key = key),
                        animatedVisibilityScope = this@AnimatedContent
                    )
                    .border(2.dp, Color.Red)
            ) {
                Text(
                    "Hello",
                    fontSize = 20.sp
                )
            }
        } else {
            Box(
                Modifier
                    .offset(180.dp, 180.dp)
                    .sharedBounds(
                        rememberSharedContentState(
                            key = key,
                        ),
                        animatedVisibilityScope = this@AnimatedContent
                    )
                    .border(2.dp, Color.Red)
                    // This padding is placed after sharedBounds, but it doesn't match the
                    // other shared elements modifier order, resulting in visual jumps
                    .padding(12.dp)

            ) {
                Text(
                    "Hello",
                    fontSize = 36.sp
                )
            }
        }
    }
}
BasicSharedElementSnippets.kt

Batas yang cocok	Batas yang tidak cocok: Perhatikan bagaimana animasi elemen bersama tampak sedikit salah karena perlu mengubah ukuran ke batas yang salah

Pengubah yang digunakan sebelum pengubah elemen bersama memberikan batasan kepada pengubah elemen bersama, yang kemudian digunakan untuk memperoleh batas awal dan target, lalu animasi batas.

Pengubah yang digunakan setelah pengubah elemen bersama menggunakan batasan dari sebelumnya untuk mengukur dan menghitung ukuran target turunan. Pengubah elemen bersama membuat serangkaian batasan animasi untuk mengubah turunan secara bertahap dari ukuran awal ke ukuran target.

Pengecualian untuk hal ini adalah jika Anda menggunakan resizeMode = ScaleToBounds() untuk animasi, atau Modifier.skipToLookaheadSize() pada composable. Dalam hal ini, Compose menata letak turunan menggunakan batasan target, dan sebagai gantinya menggunakan faktor skala untuk melakukan animasi, bukan mengubah ukuran tata letak itu sendiri.

Penting: Pastikan urutan pengubah pada item yang cocok konsisten. Tempatkan pengubah ukuran setelah pengubah elemen bersama, kecuali saat Anda menggunakan requiredSize(). Jika Anda menggunakan requiredSize() setelah pengubah elemen bersama, tidak akan ada penataan ulang turunan selama transformasi, meskipun Anda menggunakan ScaleToBounds(). Di sisi lain, jika requiredSize() berada sebelum pengubah elemen bersama, induk requiredSize() tidak akan pernah dapat mengamati elemen bersama animatedSize.

Kunci unik

Saat menangani elemen bersama yang kompleks, sebaiknya buat kunci yang bukan string, karena string dapat rentan terhadap error saat dicocokkan. Setiap kunci harus unik agar pencocokan dapat terjadi. Misalnya, di Jetsnack, kita memiliki elemen bersama berikut:

Gambar 7. Gambar yang menampilkan Jetsnack dengan anotasi untuk setiap bagian UI.

Anda dapat membuat enum untuk mewakili jenis elemen bersama. Dalam contoh ini, seluruh kartu camilan juga dapat muncul dari beberapa tempat yang berbeda di layar utama, misalnya di bagian "Populer" dan "Direkomendasikan". Anda dapat membuat kunci yang memiliki snackId, origin ("Populer"/"Direkomendasikan"), dan type dari elemen bersama yang akan dibagikan:

data class SnackSharedElementKey(
    val snackId: Long,
    val origin: String,
    val type: SnackSharedElementType
)

enum class SnackSharedElementType {
    Bounds,
    Image,
    Title,
    Tagline,
    Background
}

@Composable
fun SharedElementUniqueKey() {
    // ...
            Box(
                modifier = Modifier
                    .sharedElement(
                        rememberSharedContentState(
                            key = SnackSharedElementKey(
                                snackId = 1,
                                origin = "latest",
                                type = SnackSharedElementType.Image
                            )
                        ),
                        animatedVisibilityScope = this@AnimatedVisibility
                    )
            )
            // ...
}
BasicSharedElementSnippets.kt

Class data direkomendasikan untuk kunci karena menerapkan hashCode() dan isEquals().

Penting: Berhati-hatilah saat menggunakan daftar konten - Anda harus menambahkan nomor item ke kunci, atau menggunakan ID unik yang berbeda.

Mengelola visibilitas elemen bersama secara manual

Jika Anda mungkin tidak menggunakan AnimatedVisibility atau AnimatedContent, Anda dapat mengelola visibilitas elemen bersama sendiri. Gunakan Modifier.sharedElementWithCallerManagedVisibility() dan berikan kondisional Anda sendiri yang menentukan kapan item harus terlihat atau tidak:

var selectFirst by remember { mutableStateOf(true) }
val key = remember { Any() }
SharedTransitionLayout(
    Modifier
        .fillMaxSize()
        .padding(10.dp)
        .clickable {
            selectFirst = !selectFirst
        }
) {
    Box(
        Modifier
            .sharedElementWithCallerManagedVisibility(
                rememberSharedContentState(key = key),
                !selectFirst
            )
            .background(Color.Red)
            .size(100.dp)
    ) {
        Text(if (!selectFirst) "false" else "true", color = Color.White)
    }
    Box(
        Modifier
            .offset(180.dp, 180.dp)
            .sharedElementWithCallerManagedVisibility(
                rememberSharedContentState(
                    key = key,
                ),
                selectFirst
            )
            .alpha(0.5f)
            .background(Color.Blue)
            .size(180.dp)
    ) {
        Text(if (selectFirst) "false" else "true", color = Color.White)
    }
}
BasicSharedElementSnippets.kt

Penting: Elemen bersama tetap ada di hierarki UI meskipun visible == false. Elemen bersama memulai transisi setiap kali ukuran atau posisinya berubah karena memiliki kecocokan yang aktif. Oleh karena itu, sebaiknya hapus elemen bersama dengan visible == false dari hierarki setelah transisi selesai, dengan mengamati SharedTransitionScope.isTransitionActive.

Batasan saat ini

API ini memiliki beberapa batasan. Terutama:

• Tidak ada interoperabilitas antara View dan Compose yang didukung. Hal ini mencakup composable apa pun yang menggabungkan AndroidView, seperti Dialog.
• Tidak ada dukungan animasi otomatis untuk hal berikut:
  • Composable Gambar Bersama:
    • Secara default, ContentScale tidak dianimasikan. Kunci ini mengepaskan ke akhir yang ditetapkan ContentScale.
  • Pemangkasan bentuk - Tidak ada dukungan bawaan untuk animasi otomatis antar-bentuk - misalnya menganimasikan dari persegi menjadi lingkaran saat item bertransisi.
  • Untuk kasus yang tidak didukung, gunakan Modifier.sharedBounds(), bukan sharedElement(), dan tambahkan Modifier.animateEnterExit() ke item.