Dialogrezept

In diesem Rezept wird gezeigt, wie Sie ein Ziel als Dialogfeld anzeigen.

Funktionsweise

Damit ein Ziel als Dialogfeld angezeigt wird, müssen Sie zwei Dinge tun:

  1. DialogSceneStrategy verwenden: Erstellen Sie eine Instanz von DialogSceneStrategy und übergeben Sie sie an den Parameter sceneStrategy des Composables NavDisplay.

  2. Metadaten zum Ziel hinzufügen: Fügen Sie den Metadaten des Ziels, das als Dialogfeld angezeigt werden soll, DialogSceneStrategy.dialog() hinzu. Dies geschieht in der Funktion entry. Sie können auch ein DialogProperties-Objekt übergeben, um das Verhalten und die Darstellung des Dialogfelds anzupassen.

In diesem Beispiel ist RouteB als Dialogfeld konfiguriert. Wenn Sie von RouteA zu RouteB wechseln, wird RouteB in einem Dialogfeld angezeigt.

Der Inhalt des Dialogfelds kann nach Bedarf formatiert werden. In diesem Rezept werden die Inhalte so zugeschnitten, dass sie abgerundete Ecken haben.

Weitere Informationen finden Sie in der offiziellen Dokumentation zu benutzerdefinierten Layouts.

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

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.material3.Button
import androidx.compose.material3.Text
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.unit.dp
import androidx.compose.ui.window.DialogProperties
import androidx.lifecycle.compose.dropUnlessResumed
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.entryProvider
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.scene.DialogSceneStrategy
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 DialogActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)
        setContent {
            val backStack = rememberNavBackStack(RouteA)
            val dialogStrategy = remember { DialogSceneStrategy<NavKey>() }

            NavDisplay(
                backStack = backStack,
                onBack = { backStack.removeLastOrNull() },
                sceneStrategies = listOf(dialogStrategy),
                entryProvider = entryProvider {
                    entry<RouteA> {
                        ContentGreen("Welcome to Nav3") {
                            Button(onClick = dropUnlessResumed {
                                backStack.add(RouteB("123"))
                            }) {
                                Text("Click to open dialog")
                            }
                        }
                    }
                    entry<RouteB>(
                        metadata = DialogSceneStrategy.dialog(
                            DialogProperties(windowTitle = "Route B dialog")
                        )
                    ) { key ->
                        ContentBlue(
                            title = "Route id: ${key.id}",
                            modifier = Modifier.clip(
                                shape = RoundedCornerShape(16.dp)
                            )
                        )
                    }
                }
            )
        }
    }
}