В большинстве приложений есть несколько основных разделов, доступных через главный интерфейс навигации. В компактных окнах, например на стандартном экране телефона, пункты назначения обычно отображаются на панели навигации в нижней части окна. В развернутом окне, например в полноэкранном приложении на планшете, обычно лучше использовать панель навигации рядом с приложением, поскольку до элементов управления навигацией легче добраться, удерживая левую и правую стороны устройства.
NavigationSuiteScaffold упрощает переключение между интерфейсами навигации, показывая подходящую composable-функцию на основе WindowSizeClass. в том числе динамически изменять интерфейс при изменении размера окна во время выполнения. Режим работы по умолчанию — показывать один из следующих компонентов интерфейса:
- Панель навигации, если ширина или высота компактная или устройство находится в режиме настольного компьютера.
- Боковая панель навигации для всего остального.
NavigationSuiteScaffold показывает панель навигации в компактных окнах.
NavigationSuiteScaffold показывает панель навигации в развернутых окнах.
Добавьте зависимости
NavigationSuiteScaffold входит в библиотеку Material3 adaptive navigation suite. Добавьте зависимость для библиотеки в файл build.gradle приложения или модуля:
Kotlin
implementation("androidx.compose.material3:material3-adaptive-navigation-suite")
Яркий
implementation 'androidx.compose.material3:material3-adaptive-navigation-suite'
Создать каркас
Две основные части NavigationSuiteScaffold — это элементы набора навигации и контент для выбранного пункта назначения. Вы можете напрямую определить элементы набора навигации в composable-функции, но обычно они определяются в другом месте, например в перечислении:
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. }
В лямбде целевого контента используйте значение 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. Например, если containerColor использует цвет background, то contentColor использует цвет onBackground.
Подробнее о том, как работает система цветов, рассказывается в статье Темы Material Design 3 в Compose. При переопределении этих значений используйте значения, определенные в вашей теме, чтобы ваше приложение поддерживало темный и светлый режимы отображения:
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 по умолчанию меняет интерфейс навигации в зависимости от классов размера окна. Однако вы можете переопределить это поведение. Например, если в приложении есть одна большая панель с контентом для фида, то для окон увеличенного размера можно использовать постоянную панель навигации, а для окон компактного и среднего размера – режим работы по умолчанию.
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компонента библиотеки: