对话框目标

在 Android 导航中,术语 对话框目标 指的是应用导航图中的目标,它们以对话框窗口的形式呈现,叠加在应用界面元素和内容之上。

由于对话框目标会显示在填充导航宿主的托管目标之上,因此关于对话框目标如何与您的 NavController 的返回堆栈交互,有一些重要的注意事项。

对话框可组合项

要在 Compose 中创建对话框目标,请使用 dialog() 函数将目标添加到您的 NavHost。该函数的行为与 composable 基本相同,只是它创建的是对话框目标而不是托管目标

请看以下示例

@Serializable
object Home
@Serializable
object Settings
@Composable
fun HomeScreen(onNavigateToSettings: () -> Unit){
    Column {
        Text("Home")
        Button(onClick = onNavigateToSettings){
            Text("Open settings")
        }
    }
}

// This screen will be displayed as a dialog
@Composable
fun SettingsScreen(){
    Text("Settings")
    // ...
}

@Composable
fun MyApp() {
    val navController = rememberNavController()
    NavHost(navController, startDestination = Home) {
        composable<Home> { HomeScreen(onNavigateToSettings = { navController.navigate(route = Settings) }) }
        dialog<Settings> { SettingsScreen() }
    }
}
  1. 起始目标使用 Home 路由。由于 composable() 将其添加到图中,因此它是一个托管目标。
  2. 另一个目标使用 Settings 路由。
    • 同样,由于 dialog() 将其添加到图中,因此它是一个对话框目标。
    • 当用户从 HomeScreen 导航到 SettingsScreen 时,后者会显示在 HomeScreen 上方。
  3. 虽然 SettingsScreen 本身不包含 Dialog 可组合项,但由于它是一个对话框目标,NavHost 会将其显示在 Dialog 中。

对话框目标会显示在 NavHost 中的上一个目标之上。当对话框在您的应用中表示一个独立的屏幕,并且需要自己的生命周期和已保存状态,独立于导航图中的任何其他目标时,请使用它们。如果您需要一个用于不太复杂的提示(例如确认)的对话框,您可能更喜欢使用 AlertDialog 或相关的可组合项。

Kotlin DSL

如果您正在使用 Fragment 并使用 Kotlin DSL 来创建图,添加对话框目标与使用 Compose 时非常相似。

请看以下代码段如何也使用 dialog() 函数来添加使用 Fragment 的对话框目标

// Define destinations with serializable classes or objects
@Serializable
object Home
@Serializable
object Settings

// Add the graph to the NavController with `createGraph()`.
navController.graph = navController.createGraph(
    startDestination = Home
) {
    // Associate the home route with the HomeFragment.
    fragment<HomeFragment, Home> {
        label = "Home"
    }

    // Define the settings destination as a dialog using DialogFragment.
    dialog<SettingsFragment, Settings> {
        label = "Settings"
    }
}

XML

如果您有现有的 DialogFragment,请使用 <dialog> 元素将对话框添加到您的导航图中,如以下示例所示

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
            xmlns:app="http://schemas.android.com/apk/res-auto"
            android:id="@+id/nav_graph">

...

<dialog
    android:id="@+id/my_dialog_fragment"
    android:name="androidx.navigation.myapp.MyDialogFragment">
    <argument android:name="myarg" android:defaultValue="@null" />
        <action
            android:id="@+id/myaction"
            app:destination="@+id/another_destination"/>
</dialog>

...

</navigation>