大多数应用都有一些顶级目的地,可通过应用的主要导航界面访问这些目的地。在紧凑型窗口(例如标准手机显示屏)中,目的地通常显示在窗口底部的导航栏中。在展开的窗口(例如平板电脑上的全屏应用)中,应用旁边的侧边导航栏通常是更好的选择,因为在握住设备的左右两侧时,导航控件更容易触及。
NavigationSuiteScaffold 通过根据 WindowSizeClass 显示相应的导航界面可组合项,简化了导航界面之间的切换。这包括在运行时窗口大小更改期间动态更改界面。默认行为是显示以下任一界面组件:
- 如果宽度或高度为紧凑型,或者设备处于桌面模式,则显示导航栏
- 对于其他所有情况,显示侧边导航栏
NavigationSuiteScaffold 在紧凑型窗口中显示导航栏。
NavigationSuiteScaffold 在展开的窗口中显示侧边导航栏。添加依赖项
NavigationSuiteScaffold 是
Material3 自适应导航套件
库的一部分。在应用或模块的 build.gradle 文件中为该库添加依赖项:
Kotlin
implementation("androidx.compose.material3:material3-adaptive-navigation-suite")
Groovy
implementation 'androidx.compose.material3:material3-adaptive-navigation-suite'
创建脚手架
NavigationSuiteScaffold 的两个主要部分是导航套件项和所选目的地的内容。您可以直接在可组合项中定义导航套件项,但通常会在其他位置(例如枚举)中定义这些项:
enum class AppDestinations( @StringRes val label: Int, val icon: ImageVector, @StringRes val contentDescription: Int ) { HOME(R.string.home, Icons.Default.Home, R.string.home), FAVORITES(R.string.favorites, Icons.Default.Favorite, R.string.favorites), SHOPPING(R.string.shopping, Icons.Default.ShoppingCart, R.string.shopping), PROFILE(R.string.profile, Icons.Default.AccountBox, R.string.profile), }
如需使用 NavigationSuiteScaffold,您必须跟踪当前目的地,这可以通过使用 rememberSaveable 来实现:
var currentDestination by rememberSaveable { mutableStateOf(AppDestinations.HOME) }
在以下示例中,navigationSuiteItems 参数(类型
NavigationSuiteScope)使用其 item 函数
为单个目的地定义导航界面。目的地界面在导航栏、侧边导航栏和抽屉式导航栏中通用。如需创建导航项,您可以遍历 AppDestinations(在前面的代码段中定义):
NavigationSuiteScaffold( navigationSuiteItems = { AppDestinations.entries.forEach { item( icon = { Icon( it.icon, contentDescription = stringResource(it.contentDescription) ) }, label = { Text(stringResource(it.label)) }, selected = it == currentDestination, onClick = { currentDestination = it } ) } } ) { // TODO: Destination content. }
在目的地内容 lambda 中,使用 currentDestination 值来决定要显示哪个界面。如果您在应用中使用导航库,请在此处使用该库来显示相应的目的地。when 语句就足够了:
NavigationSuiteScaffold( navigationSuiteItems = { /*...*/ } ) { // Destination content. when (currentDestination) { AppDestinations.HOME -> HomeDestination() AppDestinations.FAVORITES -> FavoritesDestination() AppDestinations.SHOPPING -> ShoppingDestination() AppDestinations.PROFILE -> ProfileDestination() } }
更改颜色
NavigationSuiteScaffold 会在脚手架占用的整个区域
(通常是整个窗口)上创建一个 Surface。在此基础上,脚手架
会绘制特定的导航界面,例如NavigationBar。
表面和导航界面都使用应用主题中指定的值,但您可以替换主题值。
containerColor 参数指定表面的颜色。默认值为配色方案的背景颜色。contentColor
参数指定该表面上内容的颜色。 默认值为为 containerColor 指定的任何内容的“on”颜色。例如,如果
containerColor 使用 background 颜色,则 contentColor 使用 onBackground
颜色。
如需详细了解颜色系统的工作原理,请参阅 Compose 中的 Material Design 3 主题
。替换这些值时,请使用主题中定义的值,以便应用支持深色和浅色显示模式:
NavigationSuiteScaffold( navigationSuiteItems = { /* ... */ }, containerColor = MaterialTheme.colorScheme.primary, contentColor = MaterialTheme.colorScheme.onPrimary, ) { // Content... }
导航界面绘制在 NavigationSuiteScaffold 表面前面。
界面颜色的默认值由
NavigationSuiteDefaults.colors()提供,但您
也可以替换这些值。例如,如果您希望导航栏的背景透明,但其他值保持默认值,请替换
navigationBarContainerColor:
NavigationSuiteScaffold( navigationSuiteItems = { /* ... */ }, navigationSuiteColors = NavigationSuiteDefaults.colors( navigationBarContainerColor = Color.Transparent, ) ) { // Content... }
最后,您可以自定义导航界面中的每个项。调用
item函数时,您可以传入
NavigationSuiteItemColors的实例。该类指定导航栏、侧边导航栏和抽屉式导航栏中项的颜色。这意味着,您可以在每种导航界面类型中使用相同的颜色,也可以根据需要更改颜色。在
NavigationSuiteScaffold 级别定义颜色,以便对所有项使用相同的对象实例,并调用
NavigationSuiteDefaults.itemColors() 函数以仅替换要更改的项:
val myNavigationSuiteItemColors = NavigationSuiteDefaults.itemColors( navigationBarItemColors = NavigationBarItemDefaults.colors( indicatorColor = MaterialTheme.colorScheme.primaryContainer, selectedIconColor = MaterialTheme.colorScheme.onPrimaryContainer ), ) NavigationSuiteScaffold( navigationSuiteItems = { AppDestinations.entries.forEach { item( icon = { Icon( it.icon, contentDescription = stringResource(it.contentDescription) ) }, label = { Text(stringResource(it.label)) }, selected = it == currentDestination, onClick = { currentDestination = it }, colors = myNavigationSuiteItemColors, ) } }, ) { // Content... }
自定义导航类型
NavigationSuiteScaffold 的默认行为会根据 窗口大小类别更改导航界面
。不过,您可能需要替换此行为。例如,如果您的应用为 Feed 显示单个大型内容窗格,则该应用可以为展开的窗口使用永久性抽屉式导航栏,但仍会回退到紧凑型和中等窗口大小类别的默认行为:
val adaptiveInfo = currentWindowAdaptiveInfo() val customNavSuiteType = with(adaptiveInfo) { if (windowSizeClass.isWidthAtLeastBreakpoint(WIDTH_DP_EXPANDED_LOWER_BOUND)) { NavigationSuiteType.NavigationDrawer } else { NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(adaptiveInfo) } } NavigationSuiteScaffold( navigationSuiteItems = { /* ... */ }, layoutType = customNavSuiteType, ) { // Content... }
其他资源
Material Design 指南:
androidx.compose.material3库组件: