基本的な DSL のレシピ

このレシピでは、entryProvider DSL と永続的なバックスタックを使用して、2 つの画面で Navigation 3 API を使用する基本的な例を示します。

仕組み

この例は基本的なレシピと似ていますが、いくつかの重要な違いがあります。

  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.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