導覽匣

「導覽匣」元件是滑入式選單,可讓使用者前往應用程式的各個部分。使用者可以從側邊滑動或輕觸選單圖示來啟用此元件。

請考慮實作 Navigation Drawer 的三種用途:

  • 內容分類:讓使用者在不同類別之間切換,例如在新聞或網誌應用程式中。
  • 帳戶管理:提供帳戶設定和個人資料區段的快速連結,讓使用者在應用程式中管理帳戶。
  • 功能探索:將多項功能和設定整理至單一選單,方便使用者在複雜的應用程式中進行探索及存取。

Material Design 提供兩種導覽匣類型:

  • 標準:在畫面中與其他內容共用空間。
  • 模式:會顯示在畫面中其他內容的上方。

範例

您可以使用 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 參數將 DrawerState 傳遞至 ModalNavigationDrawer

DrawerState 提供 openclose 函式的存取權,以及與目前導覽匣狀態相關的屬性。這些暫停函式需要 CoroutineScope,您可以使用 rememberCoroutineScope 將其例項化。也可以呼叫暫停函式來回應 UI 事件。

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
    }
}