Compose 中的共享元素过渡

共享元素过渡是在具有内容一致的可组合项之间进行过渡的无缝方式。它们通常用于导航，允许您在用户在不同屏幕之间导航时视觉连接不同的屏幕。

例如，在以下视频中，您可以看到零食的图像和标题从列表页面共享到详细信息页面。

图 1. Jetsnack 共享元素演示

在 Compose 中，有一些高级 API 可以帮助您创建共享元素。

  • SharedTransitionLayout：实现共享元素过渡所需的外部布局。它提供了一个 SharedTransitionScope。Composable 需要在 SharedTransitionScope 中才能使用共享元素修饰符。
  • Modifier.sharedElement()：此修饰符将 Composable 标记给 SharedTransitionScope，表示该 Composable 应该与另一个 Composable 匹配。
  • Modifier.sharedBounds()：此修饰符将 Composable 标记给 SharedTransitionScope，表示此 Composable 的边界应该用作过渡发生位置的容器边界。与 sharedElement() 相反，sharedBounds() 适用于视觉上不同的内容。

在 Compose 中创建共享元素时，一个重要的概念是它们如何与叠加层和裁剪一起工作。请查看 裁剪和叠加层 部分，以了解有关此重要主题的更多信息。

基本用法

本节将构建以下过渡，从较小的“列表”项过渡到较大的详细项。

图 2. 两个 Composable 之间共享元素过渡的基本示例。

使用 Modifier.sharedElement() 的最佳方法是结合使用 AnimatedContent、AnimatedVisibility 或 NavHost，因为这会自动为您管理 Composable 之间的过渡。

起点是现有的基本 AnimatedContent，在添加共享元素之前，它具有 MainContent 和 DetailsContent Composable。

图 3. 没有任何共享元素过渡的初始 AnimatedContent。

  1. 为了使共享元素在两个布局之间进行动画，请使用 SharedTransitionLayout 包裹 AnimatedContent Composable。来自 SharedTransitionLayout 和 AnimatedContent 的作用域传递给 MainContent 和 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. 在两个匹配的 Composable 上的修饰符链中添加 Modifier.sharedElement()。创建一个 SharedContentState 对象并使用 rememberSharedContentState() 记住它。SharedContentState 对象存储用于确定共享元素的唯一键。提供一个唯一的键来标识内容，并为要记住的项目使用 rememberSharedContentState()。AnimatedContentScope 传递到修饰符中，用于协调动画。

    @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

要获取有关是否已发生共享元素匹配的信息，请将 rememberSharedContentState() 提取到一个变量中，并查询 isMatchFound。

这将导致以下自动动画。

图 4. 两个 Composable 之间共享元素过渡的基本示例。

您可能会注意到，整个容器的背景颜色和大小仍然使用默认的 AnimatedContent 设置。

共享边界与共享元素

Modifier.sharedBounds() 与 Modifier.sharedElement() 类似。但是，这些修饰符在以下方面有所不同。

  • sharedBounds() 用于视觉上不同的内容，但应在状态之间共享相同的区域，而 sharedElement() 预期内容相同。
  • 使用 sharedBounds() 时，在两个状态之间的过渡期间，进入和退出屏幕的内容是可见的，而使用 sharedElement() 时，仅在转换边界中呈现目标内容。Modifier.sharedBounds() 具有 enter 和 exit 参数，用于指定内容应如何过渡，类似于 AnimatedContent 的工作方式。
  • sharedBounds() 最常见的用例是 容器转换模式，而对于 sharedElement()，示例用例是英雄过渡。
  • 当使用 Text Composable 时，首选 sharedBounds() 以支持字体更改，例如在斜体和粗体或颜色更改之间进行过渡。

从前面的示例中，在两种不同情况下将 Modifier.sharedBounds() 添加到 Row 和 Column 上，将允许我们共享两者的边界并执行过渡动画，使它们能够彼此之间增长。

@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

图 5. 两个 Composable 之间的共享边界。

了解作用域

要使用 Modifier.sharedElement()，Composable 需要位于 SharedTransitionScope 中。SharedTransitionLayout Composable 提供了 SharedTransitionScope。确保将其放置在 UI 层次结构中包含要共享的元素的相同顶层位置。

通常，Composable 也应该放置在 AnimatedVisibilityScope 中。这通常通过使用 AnimatedContent 在 Composable 之间切换或直接使用 AnimatedVisibility，或者通过 NavHost Composable 函数来提供，除非您 手动管理可见性。为了使用多个作用域，请将所需的作用域保存在 CompositionLocal 中，使用 Kotlin 中的上下文接收器，或者将作用域作为参数传递给您的函数。

在您有多个作用域需要跟踪或层次结构嵌套很深的情况下使用 CompositionLocals。CompositionLocal 允许您选择要保存和使用的确切作用域。另一方面，当您使用上下文接收器时，层次结构中的其他布局可能会意外地覆盖提供的作用域。例如，如果您有多个嵌套的 AnimatedContent，则作用域可能会被覆盖。

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

或者，如果您的层次结构没有深度嵌套，您可以将作用域作为参数向下传递。

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

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

使用 AnimatedVisibility 的共享元素

前面的示例展示了如何将共享元素与 AnimatedContent 一起使用，但共享元素也适用于 AnimatedVisibility。

例如，在此惰性网格示例中，每个元素都包装在 AnimatedVisibility 中。当点击项目时，内容具有从 UI 中拉出到类似对话框的组件的视觉效果。

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

图 6. 使用 AnimatedVisibility 的共享元素。

修饰符顺序

对于 Modifier.sharedElement() 和 Modifier.sharedBounds()，与 Compose 的其余部分一样，修饰符链的顺序 很重要。错误放置影响大小的修饰符会导致共享元素匹配期间出现意外的视觉跳跃。

例如，如果在两个共享元素上将填充修饰符放在不同的位置，则动画中会出现视觉差异。

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

匹配的边界

不匹配的边界：请注意，共享元素动画看起来有点不正常，因为它需要调整大小到不正确的边界。

在共享元素修饰符之前使用的修饰符为共享元素修饰符提供约束，然后使用这些约束来推导出初始和目标边界，以及随后的边界动画。

在共享元素修饰符之后使用的修饰符使用之前的约束来测量和计算子元素的目标大小。共享元素修饰符创建一系列动画约束，以逐渐将子元素从初始大小转换为目标大小。

例外情况是，如果您对动画使用 resizeMode = ScaleToBounds()，或者在 Composable 上使用 Modifier.skipToLookaheadSize()。在这种情况下，Compose 使用目标约束布局子元素，而是使用比例因子来执行动画，而不是更改布局大小本身。

唯一键

处理复杂的共享元素时，最好创建一个非字符串的键，因为字符串可能容易导致匹配错误。每个键都必须是唯一的才能发生匹配。例如，在 Jetsnack 中，我们有以下共享元素。

图 7. 显示 Jetsnack 的图像，其中包含 UI 各部分的注释。

您可以创建一个枚举来表示共享元素类型。在此示例中，整个零食卡片也可以从主屏幕上的多个不同位置出现，例如在“热门”和“推荐”部分。您可以创建一个包含 snackId、origin（“热门”/“推荐”）和将要共享的共享元素的 type 的键。

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

建议使用数据类作为键，因为它们实现了 hashCode() 和 isEquals()。

手动管理共享元素的可见性

如果您没有使用AnimatedVisibility 或 AnimatedContent，则可以自行管理共享元素的可见性。使用 Modifier.sharedElementWithCallerManagedVisibility() 并提供您自己的条件来确定何时显示或隐藏项目。

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

当前限制

这些 API 有一些限制。最值得注意的是

  • 不支持 Views 和 Compose 之间的互操作性。这包括任何包装 AndroidView 的可组合项，例如 Dialog。
  • 以下内容没有自动动画支持
    • 共享图像可组合项:
      • ContentScale 默认情况下不会进行动画处理。它会直接切换到设置的最终 ContentScale。
    • 形状裁剪 - 没有内置支持在形状之间进行自动动画，例如在项目过渡时从正方形动画到圆形。
    • 对于不支持的情况，请使用 Modifier.sharedBounds() 而不是 sharedElement()，并在项目上添加 Modifier.animateEnterExit()。
下一步
自定义