導覽邊欄

在螢幕較大的裝置上，導覽邊欄可讓使用者前往應用程式中的目的地。導覽邊欄適用於：

  • 在應用程式中任何位置都能存取的頂層目的地
  • 三到七個主要目的地
  • 平板電腦或電腦版面配置
螢幕左側的垂直導覽邊欄，其中有四個目的地 (所有檔案、最近、相片和媒體庫)，每個目的地都有相關聯的圖示和懸浮動作按鈕。
圖 1. 有四個目的地和一個懸浮動作按鈕的導覽邊欄。

本頁面說明如何使用相關畫面和基本導覽功能，在應用程式中顯示側欄。

API 介面

搭配使用 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)，前往對應的畫面。
  • NavigationRailItem 的 onClick lambda 會更新 selectedDestination 狀態，以視覺方式醒目顯示點選的側欄項目。
  • 它會呼叫 AppNavHost 可組合函式，傳遞 navController 和 startDestination，以顯示所選畫面的實際內容。

結果

下圖顯示上述程式碼片段的結果：

垂直導覽邊欄，內含 3 個目的地和相關聯的圖示：歌曲、專輯和播放清單。圖示會以視覺方式指出導覽邊欄中每個導覽按鈕的用途。每個目的地都有相關聯的圖示 (例如「歌曲」的音符圖示)。
圖 2. 導覽邊欄，包含 3 個目的地和相關圖示：歌曲、專輯和播放清單。

其他資源