Einfaches DSL-Rezept

In diesem Rezept wird ein einfaches Beispiel für die Verwendung der Navigation 3 API mit zwei Bildschirmen gezeigt. Dabei werden die entryProvider-DSL und ein persistenter Backstack verwendet.

Funktionsweise

Dieses Beispiel ähnelt dem einfachen Rezept, weist aber einige wichtige Unterschiede auf:

  1. Persistent Back Stack: Hier wird rememberNavBackStack(RouteA) verwendet, um den Backstack zu erstellen und zu speichern. Dadurch bleibt der Backstack bei Konfigurationsänderungen (z.B. Bildschirmdrehung) erhalten. Damit rememberNavBackStack verwendet werden kann, müssen die Navigationsschlüssel serialisierbar sein. Daher sind RouteA und RouteB mit @Serializable annotiert und implementieren die NavKey-Schnittstelle.

  2. entryProvider DSL: Anstelle einer when-Anweisung wird in diesem Beispiel die entryProvider DSL verwendet, um den Inhalt für jede Route zu definieren. Mit der Funktion entry<RouteType> wird einem Routentyp der zugehörige komponierbare Inhalt zugewiesen.

Die Navigationslogik bleibt dieselbe: Um von RouteA zu RouteB zu wechseln, fügen wir dem Backstack eine RouteB-Instanz hinzu.

/*
 * 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.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 = {
                                backStack.add(RouteB("123"))
                            }) {
                                Text("Click to navigate")
                            }
                        }
                    }
                    entry<RouteB> { key ->
                        ContentBlue("Route id: ${key.id} ")
                    }
                }
            )
        }
    }
}

BasicDslActivity.kt