Compose 中的共享元素过渡

共享元素转换可在内容保持一致的可组合项之间无缝转换。它们通常用于导航，可让您在用户在不同屏幕之间导航时，直观地将这些屏幕关联起来。

例如，在以下视频中，您可以看到零食的图片和标题从商品详情页面共享到详情页面。

图 1. Jetsnack 共享元素演示

在 Compose 中，有几个高级 API 可帮助您创建共享元素：

  • SharedTransitionLayout：实现共享元素转换所需的最外部布局。它会提供 SharedTransitionScope。可组合项需要位于 SharedTransitionScope 中才能使用共享元素修饰符。
  • Modifier.sharedElement()：用于向 SharedTransitionScope 标记应与另一个可组合项匹配的可组合项的修饰符。
  • Modifier.sharedBounds()：此修饰符会向 SharedTransitionScope 标记，指明应将此可组合项的边界用作应进行转换的位置的容器边界。与 sharedElement() 不同，sharedBounds() 适用于视觉效果不同的内容。

在 Compose 中创建共享元素时，一个重要的概念是共享元素如何与叠加层和剪裁功能搭配使用。请参阅剪裁和叠加层部分，详细了解此重要主题。

基本用法

本部分将构建以下转换，从较小的“列表”项转换为较大的详细项：

图 2. 两个可组合项之间共享元素转换的基本示例。

使用 Modifier.sharedElement() 的最佳方式是将其与 AnimatedContent、AnimatedVisibility 或 NavHost 搭配使用，因为这样可以自动为您管理可组合项之间的转换。

起点是添加共享元素之前包含 MainContent 和 DetailsContent 可组合项的现有基本 AnimatedContent：

图 3. 启动 AnimatedContent，不使用任何共享元素转换。

  1. 为了让共享元素在两个布局之间添加动画效果，请使用 SharedTransitionLayout 将 AnimatedContent 可组合项括起来。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. 将 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. 两个可组合项之间共享元素转换的基本示例。

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

共享边界与共享元素

Modifier.sharedBounds() 类似于 Modifier.sharedElement()。不过，修饰符在以下方面有所不同：

  • sharedBounds() 适用于视觉上不同的内容，但在不同状态之间应共享相同的区域，而 sharedElement() 则要求内容保持一致。
  • 使用 sharedBounds() 时，在两种状态之间转换期间，进入和退出屏幕的内容会显示，而使用 sharedElement() 时，只有目标内容会在转换边界中呈现。Modifier.sharedBounds() 具有 enter 和 exit 参数，用于指定内容应如何转换，类似于 AnimatedContent 的运作方式。
  • sharedBounds() 最常见的用例是容器转换模式，而 sharedElement() 的示例用例是主推介内容转场效果。
  • 使用 Text 可组合项时，最好使用 sharedBounds() 来支持字体更改，例如在斜体和粗体之间进行转换或更改颜色。

在前面的示例中，在两种不同场景中将 Modifier.sharedBounds() 添加到 Row 和 Column 后，我们可以共享这两个 View 的边界并执行转换动画，从而让这两个 View 在彼此之间展开：

@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. 两个可组合项之间的共享边界。

了解作用域

如需使用 Modifier.sharedElement()，可组合项需要位于 SharedTransitionScope 中。SharedTransitionLayout 可组合项提供 SharedTransitionScope。请务必将其放置在界面层次结构中包含要共享的元素的同一顶级位置。

通常，可组合项也应放置在 AnimatedVisibilityScope 中。通常，可通过使用 AnimatedContent 在可组合项之间切换、直接使用 AnimatedVisibility 或通过 NavHost 可组合函数来提供此功能，除非您手动管理可见性。如需使用多个作用域，请将所需作用域保存在 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 中。点击该项后，内容会从界面中拉出到类似对话框的组件中，从而产生视觉效果。

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 的共享元素。

修饰符排序

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

例如，如果您在两个共享元素上将内边距修饰符放置在不同的位置，动画就会有视觉差异。

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()，或对可组合项使用 Modifier.skipToLookaheadSize()。在这种情况下，Compose 会使用目标约束条件来布局子项，并改用缩放比例来执行动画，而不是更改布局大小本身。

唯一键

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

图 7. 显示 Jetsnack 的图片，其中包含界面各部分的注释。

您可以创建一个枚举来表示共享的元素类型。在此示例中，整个动态卡片还可以在主屏幕上的多个不同位置显示，例如“热门”和“推荐”部分。您可以创建一个键，其中包含要共享的共享元素的 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 有一些限制。最值得注意的是：

  • 不支持 View 和 Compose 之间的互操作性。这包括封装 AndroidView 的任何可组合项，例如 Dialog。
  • 以下内容不支持自动动画：
    • 共享图片可组合项：
      • 默认情况下，ContentScale 不会呈现动画效果。它会贴靠到设定的结束点 ContentScale。
    • 形状剪裁 - 系统不内置对形状之间自动动画的支持，例如在项转换时从方形变为圆形的动画。
    • 对于不受支持的情况，请使用 Modifier.sharedBounds() 而非 sharedElement()，并在项中添加 Modifier.animateEnterExit()。
下一页
自定义