Панель навигации

Панель навигации – это выдвижное меню, которое позволяет пользователям переходить в различные разделы приложения. Чтобы открыть его, нужно провести пальцем от края экрана или нажать на значок меню.

Рассмотрим три варианта использования панели навигации:

  • Организация контента. Позволяет пользователям переключаться между разными категориями, например в новостных приложениях или приложениях для ведения блогов.
  • Управление аккаунтом. Добавьте быстрые ссылки на настройки аккаунта и разделы профиля в приложениях с аккаунтами пользователей.
  • Поиск функций. В сложных приложениях можно объединить несколько функций и настроек в одном меню, чтобы пользователям было проще их находить и использовать.

В Material Design есть два типа панелей навигации:

  • Стандартный. Контент занимает часть экрана.
  • Модальное окно. Появляется поверх другого контента на экране.
Пример панели навигации Material Design 3 в светлом и тёмном режимах.
Рисунок 1. Пример панели навигации.

Пример

Для реализации панели навигации можно использовать composable-функцию ModalNavigationDrawer.

Используйте слот drawerContent, чтобы предоставить ModalDrawerSheet и содержимое панели, как в следующем примере:

ModalNavigationDrawer(
    drawerContent = {
        ModalDrawerSheet {
            Text("Drawer title", modifier = Modifier.padding(16.dp))
            HorizontalDivider()
            NavigationDrawerItem(
                label = { Text(text = "Drawer Item") },
                selected = false,
                onClick = { /*TODO*/ }
            )
            // ...other drawer items
        }
    }
) {
    // Screen content
}

ModalNavigationDrawer принимает ряд дополнительных параметров боковой панели. Например, вы можете включить или отключить реакцию панели на перетаскивание с помощью параметра gesturesEnabled, как показано в следующем примере:

ModalNavigationDrawer(
    drawerContent = {
        ModalDrawerSheet {
            // Drawer contents
        }
    },
    gesturesEnabled = false
) {
    // Screen content
}

Управление поведением

Чтобы открыть или закрыть панель, используйте DrawerState. Вам нужно передать DrawerState в ModalNavigationDrawer с помощью параметра drawerState.

DrawerState предоставляет доступ к функциям open и close, а также к свойствам, связанным с текущим состоянием панели. Для этих функций приостановки требуется CoroutineScope, экземпляр которого можно создать с помощью rememberCoroutineScope. Вы также можете вызывать приостанавливающие функции в ответ на события пользовательского интерфейса.

val drawerState = rememberDrawerState(initialValue = DrawerValue.Closed)
val scope = rememberCoroutineScope()
ModalNavigationDrawer(
    drawerState = drawerState,
    drawerContent = {
        ModalDrawerSheet { /* Drawer content */ }
    },
) {
    Scaffold(
        floatingActionButton = {
            ExtendedFloatingActionButton(
                text = { Text("Show drawer") },
                icon = { Icon(Icons.Filled.Add, contentDescription = "") },
                onClick = {
                    scope.launch {
                        drawerState.apply {
                            if (isClosed) open() else close()
                        }
                    }
                }
            )
        }
    ) { contentPadding ->
        // Screen content
    }
}

Создание групп на панели навигации

В следующем фрагменте кода показано, как создать подробную панель навигации с разделами и разделителями:

@Composable
fun DetailedDrawerExample(
    content: @Composable (PaddingValues) -> Unit
) {
    val drawerState = rememberDrawerState(initialValue = DrawerValue.Closed)
    val scope = rememberCoroutineScope()

    ModalNavigationDrawer(
        drawerContent = {
            ModalDrawerSheet {
                Column(
                    modifier = Modifier.padding(horizontal = 16.dp)
                        .verticalScroll(rememberScrollState())
                ) {
                    Spacer(Modifier.height(12.dp))
                    Text("Drawer Title", modifier = Modifier.padding(16.dp), style = MaterialTheme.typography.titleLarge)
                    HorizontalDivider()

                    Text("Section 1", modifier = Modifier.padding(16.dp), style = MaterialTheme.typography.titleMedium)
                    NavigationDrawerItem(
                        label = { Text("Item 1") },
                        selected = false,
                        onClick = { /* Handle click */ }
                    )
                    NavigationDrawerItem(
                        label = { Text("Item 2") },
                        selected = false,
                        onClick = { /* Handle click */ }
                    )

                    HorizontalDivider(modifier = Modifier.padding(vertical = 8.dp))

                    Text("Section 2", modifier = Modifier.padding(16.dp), style = MaterialTheme.typography.titleMedium)
                    NavigationDrawerItem(
                        label = { Text("Settings") },
                        selected = false,
                        icon = { Icon(Icons.Outlined.Settings, contentDescription = null) },
                        badge = { Text("20") }, // Placeholder
                        onClick = { /* Handle click */ }
                    )
                    NavigationDrawerItem(
                        label = { Text("Help and feedback") },
                        selected = false,
                        icon = { Icon(Icons.AutoMirrored.Outlined.Help, contentDescription = null) },
                        onClick = { /* Handle click */ },
                    )
                    Spacer(Modifier.height(12.dp))
                }
            }
        },
        drawerState = drawerState
    ) {
        Scaffold(
            topBar = {
                TopAppBar(
                    title = { Text("Navigation Drawer Example") },
                    navigationIcon = {
                        IconButton(onClick = {
                            scope.launch {
                                if (drawerState.isClosed) {
                                    drawerState.open()
                                } else {
                                    drawerState.close()
                                }
                            }
                        }) {
                            Icon(Icons.Default.Menu, contentDescription = "Menu")
                        }
                    }
                )
            }
        ) { innerPadding ->
            content(innerPadding)
        }
    }
}

Важные сведения о коде

  • Заполняет drawerContent с помощью Column, содержащего разделы, разделители и элементы навигации.
  • ModalDrawerSheet обеспечивает оформление панели в стиле Material Design.
  • HorizontalDivider разделяет разделы в боковом меню.
  • ModalNavigationDrawer создает панель.
  • drawerContent определяет контент панели.
  • Внутри ModalDrawerSheet элементы панели упорядочиваются по вертикали с помощью Column.
  • NavigationDrawerItem представляют отдельные элементы в панели.
  • Scaffold обеспечивает базовую структуру экрана, включая TopAppBar.
  • navigationIcon в TopAppBar управляет открытием и закрытием панели.

Результат

На изображении ниже показано, как выглядит открытая боковая панель с разделами и элементами.

Подробная панель навигации с двумя разделами, в каждом из которых есть несколько элементов с метками и значками.
Рисунок 2. Открытая панель навигации с двумя вложенными группами.

Дополнительные ресурсы