Навигация с помощью общих элементов

Рисунок 1. Навигация с помощью общих элементов.

Общие элементы делают переходы между экранами более плавными и привлекательными, создавая визуальную связь, которая направляет пользователя. В этом руководстве рассказывается, как использовать API общих элементов с библиотеками Jetpack Navigation 3 и Navigation 2.

В приведенном ниже фрагменте кода есть композиции DetailsScreen и HomeScreen, которые служат пунктами назначения, между которыми могут перемещаться пользователи. На каждом экране модификатор sharedElement применяется и к изображению, и к тексту, чтобы каждый из этих элементов анимировался независимо от других.

@Composable
fun DetailsScreen(
    id: Int,
    snack: Snack,
    sharedTransitionScope: SharedTransitionScope,
    animatedVisibilityScope: AnimatedVisibilityScope,
    onBackPressed: () -> Unit
) {
    with(sharedTransitionScope) {
        Column(
            modifier = Modifier
                .fillMaxSize()
                .clickable { onBackPressed() },
        ) {
            Image(
                painterResource(id = snack.image),
                contentDescription = snack.description,
                contentScale = ContentScale.Crop,
                modifier = Modifier
                    .sharedElement(
                        sharedTransitionScope.rememberSharedContentState(key = "image-$id"),
                        animatedVisibilityScope = animatedVisibilityScope
                    )
                    .aspectRatio(1f)
                    .fillMaxWidth()
            )
            Text(
                text = snack.name,
                fontSize = 18.sp,
                modifier = Modifier
                    .sharedElement(
                        sharedTransitionScope.rememberSharedContentState(key = "text-$id"),
                        animatedVisibilityScope = animatedVisibilityScope
                    )
                    .fillMaxWidth(),
            )
        }
    }
}

@Composable
fun HomeScreen(
    sharedTransitionScope: SharedTransitionScope,
    animatedVisibilityScope: AnimatedVisibilityScope,
    onItemClick: (Int) -> Unit,
) {
    LazyColumn(
        modifier = Modifier
            .fillMaxSize()
            .padding(8.dp),
        verticalArrangement = Arrangement.spacedBy(8.dp)
    ) {
        itemsIndexed(listSnacks) { index, item ->
            Row(
                modifier = Modifier
                    .fillMaxWidth()
                    .clickable { onItemClick(index) },
            ) {
                Spacer(modifier = Modifier.width(8.dp))
                with(sharedTransitionScope) {
                    Image(
                        painterResource(id = item.image),
                        contentDescription = item.description,
                        contentScale = ContentScale.Crop,
                        modifier = Modifier
                            .sharedElement(
                                sharedTransitionScope.rememberSharedContentState(key = "image-$index"),
                                animatedVisibilityScope = animatedVisibilityScope
                            )
                            .size(100.dp)
                    )
                    Spacer(modifier = Modifier.width(8.dp))
                    Text(
                        item.name,
                        fontSize = 18.sp,
                        modifier = Modifier
                            .align(Alignment.CenterVertically)
                            .sharedElement(
                                sharedTransitionScope.rememberSharedContentState(key = "text-$index"),
                                animatedVisibilityScope = animatedVisibilityScope,
                            )
                    )
                }
            }
        }
    }
}

Чтобы использовать API общего элемента с Navigation 3, сначала оберните NavDisplay приложения в SharedTransitionLayout. Затем вы можете передать предоставленный SharedTransitionScope в композиции экрана.

Для AnimatedVisibilityScope используйте локальную композицию LocalNavAnimatedContentScope, которая предоставляет AnimatedContentScope из AnimatedContent, используемого NavDisplay для анимации между сценами.

@Composable
fun SharedElement_Nav3() {
    SharedTransitionLayout {
        val backStack = rememberNavBackStack(HomeRoute)

        // Note: NavDisplay accepts a `sharedTransitionScope` parameter, which is used to animate
        // NavEntry instances between scenes. This parameter *isn't* required for shared element
        // or shared bounds transitioning elements between different NavEntry, as demonstrated in
        // this sample.
        // See https://developer.android.com/guide/navigation/navigation-3/animate-destinations#transition-nav-entries
        NavDisplay(
            modifier = Modifier.safeDrawingPadding(),
            backStack = backStack,
            entryProvider = entryProvider {
                entry<HomeRoute> {
                    HomeScreen(
                        sharedTransitionScope = this@SharedTransitionLayout,
                        animatedVisibilityScope = LocalNavAnimatedContentScope.current,
                        onItemClick = { backStack.add(DetailsRoute(it)) })
                }
                entry<DetailsRoute> { detailsRoute ->
                    val id = detailsRoute.item
                    val snack = listSnacks[id]

                    DetailsScreen(
                        id = id,
                        snack = snack,
                        sharedTransitionScope = this@SharedTransitionLayout,
                        animatedVisibilityScope = LocalNavAnimatedContentScope.current,
                        onBackPressed = {
                            backStack.removeLastOrNull()
                        },
                    )
                }
            })
    }
}

Чтобы использовать API общих элементов с Navigation 2, сначала нужно обернуть NavHost приложения в SharedTransitionLayout. Затем вы можете передать полученный объект SharedTransitionScope в композиции экрана.

Параметр content сборщика composable использует AnimatedContentScope в качестве получателя, поэтому вы можете использовать this@composable для ссылки на эту область действия.

@Composable
fun SharedElement_Nav2() {
    SharedTransitionLayout {
        val navController = rememberNavController()
        NavHost(
            navController = navController,
            startDestination = "home",
            modifier = Modifier.safeDrawingPadding()
        ) {
            composable("home") {
                HomeScreen(
                    sharedTransitionScope = this@SharedTransitionLayout,
                    animatedVisibilityScope = this@composable,
                    onItemClick = { navController.navigate("details/$it") })
            }
            composable(
                "details/{item}", arguments = listOf(navArgument("item") { type = NavType.IntType })
            ) { backStackEntry ->
                val id = backStackEntry.arguments?.getInt("item") ?: 0
                val snack = listSnacks[id]
                DetailsScreen(
                    id = id,
                    snack = snack,
                    sharedTransitionScope = this@SharedTransitionLayout,
                    animatedVisibilityScope = this@composable,
                    onBackPressed = {
                        navController.popBackStack()
                    }
                )
            }
        }
    }
}

Предпросмотр для жеста "Назад" с общими элементами

Чтобы использовать предпросмотр для жеста "Назад" с общими элементами, выполните следующие действия:

  1. Предпросмотр для жеста "Назад" поддерживается во всех версиях Navigation 3. Для Navigation 2 используйте версию 2.8.0-alpha02 navigation-compose или более новую:

    [versions]
androidx-navigation = "2.8.0-alpha02" # Or newer

[libraries]
androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "androidx-navigation" }

    dependencies {
    implementation(libs.androidx.navigation.compose)
}

  2. Анимация предпросмотра для жеста "Назад" по умолчанию включена на устройствах с Android 15 (уровень API 35) или более поздней версии. На устройствах с Android 14 (уровень API 34) нужно включить предпросмотр для жеста "Назад" в настройках для разработчиков.

  3. Если ваше приложение предназначено для Android 14 или более ранней версии, вам нужно добавить android:enableOnBackInvokedCallback="true" в элементы <application> или <activity> в файле AndroidManifest.xml. Если ваше приложение предназначено для Android 15 или более поздних версий, этот флаг не нужен.

    <manifest xmlns:android="http://schemas.android.com/apk/res/android">
  <application
      ...
      android:enableOnBackInvokedCallback="true">
  </application>
</manifest>
Рисунок 2. Общие элементы с предпросмотром для жеста "Назад".
Назад
Примеры использования
Далее
Дополнительные примеры