Receta básica de DSL

En esta receta, se muestra un ejemplo básico de cómo usar la API de Navigation 3 con dos pantallas, el DSL de entryProvider y una pila de historial persistente.

Cómo funciona

Este ejemplo es similar a la receta básica, pero con algunas diferencias clave:

  1. Pila de historial persistente: Usa rememberNavBackStack(RouteA) para crear y recordar la pila de historial. Esto hace que la pila de actividades sea persistente en los cambios de configuración (p.ej., rotación de pantalla). Para usar rememberNavBackStack, las claves de navegación deben ser serializables, por lo que RouteA y RouteB se anotan con @Serializable y se implementa la interfaz NavKey.

  2. DSL de entryProvider: En lugar de una instrucción when, este ejemplo usa la DSL de entryProvider para definir el contenido de cada ruta. La función entry<RouteType> se usa para asociar un tipo de ruta con su contenido componible.

La lógica de navegación sigue siendo la misma: para navegar de RouteA a RouteB, agregamos una instancia de RouteB a la pila de historial.

/*
 * 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