Базовый рецепт DSL

В этом рецепте показан базовый пример использования Navigation 3 API с двумя экранами, DSL entryProvider и постоянным обратным стеком.

Принцип работы

Этот пример похож на базовый, но с несколькими ключевыми отличиями:

  1. Постоянный стек возврата. Для создания и сохранения стека возврата используется rememberNavBackStack(RouteA). Это позволяет сохранять стек возврата при изменении конфигурации, например при повороте экрана. Чтобы использовать rememberNavBackStack, клавиши навигации должны быть сериализуемыми, поэтому RouteA и RouteB аннотированы с помощью @Serializable и реализуют интерфейс NavKey.

  2. entryProvider DSL. Вместо оператора when в этом примере для определения контента каждого маршрута используется entryProvider DSL. Функция entry<RouteType> используется, чтобы связать тип маршрута с его составным контентом.

Логика навигации остается прежней: чтобы перейти от RouteA к RouteB, мы добавляем экземпляр RouteB в обратный стек.

/*
 * Copyright 2025 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.example.nav3recipes.basicdsl

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material3.Button
import androidx.compose.material3.Text
import androidx.lifecycle.compose.dropUnlessResumed
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.entryProvider
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.ui.NavDisplay
import com.example.nav3recipes.content.ContentBlue
import com.example.nav3recipes.content.ContentGreen
import com.example.nav3recipes.ui.setEdgeToEdgeConfig
import kotlinx.serialization.Serializable

@Serializable
private data object RouteA : NavKey

@Serializable
private data class RouteB(val id: String) : NavKey

class BasicDslActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)
        setContent {
            val backStack = rememberNavBackStack(RouteA)

            NavDisplay(
                backStack = backStack,
                onBack = { backStack.removeLastOrNull() },
                entryProvider = entryProvider {
                    entry<RouteA> {
                        ContentGreen("Welcome to Nav3") {
                            Button(onClick = dropUnlessResumed {
                                backStack.add(RouteB("123"))
                            }) {
                                Text("Click to navigate")
                            }
                        }
                    }
                    entry<RouteB> { key ->
                        ContentBlue("Route id: ${key.id} ")
                    }
                }
            )
        }
    }
}