侧边导航栏

轨道可用于访问在大屏设备上运行的应用中的目的地。您应使用导航栏执行以下操作:

  • 需要在应用中的任何位置都能访问的顶级目的地
  • 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)
    }
}

要点

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

结果

下图显示了上一个代码段的运行结果:

一个垂直的侧边导航栏,其中包含 3 个目的地及其关联的图标:歌曲、专辑和播放列表。图标直观地指示了轨道中每个导航按钮的用途。每个目的地都配有相关图标(例如,音乐图标表示音乐目的地,
图 2. 包含 3 个目的地(歌曲、专辑和播放列表)及相关联图标的侧边导航栏。

其他资源