導覽邊欄

Rails 可讓您存取在大螢幕裝置上執行的應用程式中的目的地。您應使用導覽軌，適用於：

  • 頂層目的地，必須可在應用程式中的任何位置存取
  • 三到七個主要目的地
  • 平板電腦或電腦版面配置
畫面左側的直向導覽列，包含四個目的地 (所有檔案、最近、相片和圖書館)，每個目的地都有相關聯的圖示，以及一個浮動動作按鈕。
圖 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)
    }
}
Navigation.kt

重點

  • 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 個目的地和相關圖示：歌曲、專輯和播放清單。

其他資源