侧边导航栏

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

  • 需要在应用中的任何位置都可访问的顶级目的地
  • 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，以显示所选屏幕的实际内容。

结果

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

一个垂直导航栏，其中包含 3 个带有关联图标的目的地：歌曲、专辑和播放列表。图标直观地指明侧边栏中每个导航按钮的用途。每个目的地都与相关的图标搭配使用（例如，音乐符号表示
图 2. 一个侧边导航栏，其中包含 3 个带有关联图标的目的地：歌曲、专辑和播放列表。

其他资源