侧边导航栏

通过边栏，用户可以访问在大屏设备上运行的应用中的目的地。您应在以下情况下使用侧边导航栏：

• 需要从应用中的任何位置访问的顶层目的地
• 3 到 7 个主要目的地
• 平板电脑或桌面设备布局

图 1. 包含四个目的地和一个悬浮操作按钮的侧边导航栏。

本页面介绍了如何在应用中显示边栏，以及相关屏幕和基本导航。

API Surface

将 NavigationRail 可组合项与 NavigationRailItem 搭配使用，在应用中实现边栏。NavigationRailItem 表示导轨列中的单个导轨项。

NavigationRailItem 包含以下关键参数：

• selected：确定当前导轨项是否在视觉上突出显示。
• onClick()：一个必需的 lambda 函数，用于定义用户点击边栏项时要执行的操作。您通常会在此处处理导航事件、更新所选边栏项状态或加载相应内容。
• label：在导轨项中显示文本。可选。
• icon：在侧边栏项中显示图标。可选。

示例：基于侧边栏的导航

以下代码段实现了一个导航栏，以便用户在应用中的不同屏幕之间导航：

注意： 完整源代码包含为以下示例建立基本导航结构的代码。

@Composable
fun NavigationRailExample(modifier: Modifier = Modifier) {
    val navController = rememberNavController()
    val startDestination = Destination.SONGS
    var selectedDestination by rememberSaveable { mutableIntStateOf(startDestination.ordinal) }

    Scaffold(modifier = modifier) { contentPadding ->
        NavigationRail(modifier = Modifier.padding(contentPadding)) {
            Destination.entries.forEachIndexed { index, destination ->
                NavigationRailItem(
                    selected = selectedDestination == index,
                    onClick = {
                        navController.navigate(route = destination.route)
                        selectedDestination = index
                    },
                    icon = {
                        Icon(
                            destination.icon,
                            contentDescription = destination.contentDescription
                        )
                    },
                    label = { Text(destination.label) }
                )
            }
        }
        AppNavHost(navController, startDestination)
    }
}
Navigation.kt

要点

• NavigationRail 会显示一列垂直的导轨项，其中每个项对应一个 Destination。
• val navController = rememberNavController() 会创建并记住 NavHostController 的实例，该实例用于管理 NavHost 中的导航。
• var selectedDestination by rememberSaveable { mutableIntStateOf(startDestination.ordinal) } 管理所选导轨项的状态。
  • startDestination.ordinal 获取 Destination.SONGS 枚举条目的数字索引（位置）。
• 点击侧边栏项时，系统会调用 navController.navigate(route = destination.route) 以导航到相应界面。
• NavigationRailItem 的 onClick lambda 会更新 selectedDestination 状态，以直观地突出显示点击的边栏项。
• 它会调用 AppNavHost 可组合项，并传递 navController 和 startDestination，以显示所选屏幕的实际内容。

结果

下图显示了上述代码段的结果：

图 2. 包含 3 个目的地及其关联图标的导航栏：歌曲、专辑和播放列表。

其他资源

• Material 3 - 侧边导航栏
• 使用 Navigation with Compose