Mem-build navigasi adaptif

Sebagian besar aplikasi memiliki beberapa tujuan tingkat atas yang dapat diakses melalui UI navigasi utama aplikasi. Di jendela yang ringkas, seperti tampilan ponsel standar, tujuan biasanya ditampilkan di menu navigasi di bagian bawah jendela. Di jendela yang diperluas, seperti aplikasi layar penuh di tablet, kolom samping navigasi di samping aplikasi biasanya merupakan pilihan yang lebih baik karena kontrol navigasi lebih mudah dijangkau dengan memegang sisi kiri dan kanan perangkat.

NavigationSuiteScaffold menyederhanakan peralihan antar-UI navigasi dengan menampilkan composable UI navigasi yang sesuai berdasarkan WindowSizeClass. Hal ini mencakup perubahan UI secara dinamis selama perubahan ukuran periode runtime. Perilaku default-nya adalah menampilkan salah satu komponen UI berikut:

• Menu navigasi jika lebar atau tingginya ringkas atau jika perangkat dalam pose di atas meja
• Kolom samping navigasi untuk lainnya

Menambahkan dependensi

NavigationSuiteScaffold adalah bagian dari library rangkaian navigasi adaptif Material3. Tambahkan dependensi untuk library dalam file build.gradle aplikasi atau modul Anda:

implementation("androidx.compose.material3:material3-adaptive-navigation-suite")

implementation 'androidx.compose.material3:material3-adaptive-navigation-suite'

Membuat scaffold

Dua bagian utama dari NavigationSuiteScaffold adalah item suite navigasi dan konten untuk tujuan yang dipilih. Anda dapat langsung menentukan item rangkaian navigasi dalam composable, tetapi biasanya hal ini ditentukan di tempat lain, misalnya, dalam enum:

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),
}
SampleNavigationSuiteScaffold.kt

Untuk menggunakan NavigationSuiteScaffold, Anda harus melacak tujuan saat ini, yang dapat Anda lakukan menggunakan rememberSaveable:

var currentDestination by rememberSaveable { mutableStateOf(AppDestinations.HOME) }
SampleNavigationSuiteScaffold.kt

Pada contoh berikut, parameter navigationSuiteItems (jenis NavigationSuiteScope menggunakan fungsi item untuk menentukan UI navigasi bagi setiap tujuan. UI tujuan digunakan di seluruh menu navigasi, kolom samping, dan panel samping. Untuk membuat item navigasi, Anda melakukan loop melalui AppDestinations (ditentukan dalam cuplikan sebelumnya):

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.
}
SampleNavigationSuiteScaffold.kt

Dalam lambda konten tujuan, gunakan nilai currentDestination untuk menentukan UI yang akan ditampilkan. Jika Anda menggunakan library navigasi di aplikasi Anda, gunakan library tersebut di sini untuk menampilkan tujuan yang sesuai. Pernyataan when sudah cukup:

NavigationSuiteScaffold(
    navigationSuiteItems = { /*...*/ }
) {
    // Destination content.
    when (currentDestination) {
        AppDestinations.HOME -> HomeDestination()
        AppDestinations.FAVORITES -> FavoritesDestination()
        AppDestinations.SHOPPING -> ShoppingDestination()
        AppDestinations.PROFILE -> ProfileDestination()
    }
}
SampleNavigationSuiteScaffold.kt

Ubah warna

NavigationSuiteScaffold membuat Surface di seluruh area yang ditempati scaffold, biasanya jendela penuh. Selain itu, scaffold menggambar UI navigasi tertentu, seperti NavigationBar. Platform dan UI navigasi menggunakan nilai yang ditentukan dalam tema aplikasi, tetapi Anda dapat mengganti nilai tema.

Parameter containerColor menentukan warna platform. Defaultnya adalah warna latar belakang skema warna Anda. Parameter contentColor menentukan warna konten pada platform tersebut. Defaultnya adalah warna "aktif" dari apa pun yang ditentukan untuk containerColor. Misalnya, jika containerColor menggunakan warna background, contentColor akan menggunakan warna onBackground. Lihat Tema Desain Material 3 di Compose untuk detail selengkapnya tentang cara kerja sistem warna. Saat mengganti nilai ini, gunakan nilai yang ditentukan dalam tema agar aplikasi Anda mendukung mode tampilan gelap dan terang:

NavigationSuiteScaffold(
    navigationSuiteItems = { /* ... */ },
    containerColor = MaterialTheme.colorScheme.primary,
    contentColor = MaterialTheme.colorScheme.onPrimary,
) {
    // Content...
}
SampleNavigationSuiteScaffold.kt

UI navigasi digambar di depan platform NavigationSuiteScaffold. Nilai default untuk warna UI disediakan oleh NavigationSuiteDefaults.colors(), tetapi Anda juga dapat mengganti nilai ini. Misalnya, jika Anda ingin latar belakang menu navigasi transparan tetapi nilai lainnya menjadi default, ganti navigationBarContainerColor:

NavigationSuiteScaffold(
    navigationSuiteItems = { /* ... */ },
    navigationSuiteColors = NavigationSuiteDefaults.colors(
        navigationBarContainerColor = Color.Transparent,
    )
) {
    // Content...
}
SampleNavigationSuiteScaffold.kt

Pada akhirnya, Anda dapat menyesuaikan setiap item di UI navigasi. Saat memanggil fungsi item, Anda dapat meneruskan instance NavigationSuiteItemColors. Class ini menentukan warna item di menu navigasi, kolom samping navigasi, dan panel navigasi. Artinya, Anda dapat memiliki warna yang sama di setiap jenis UI navigasi, atau memvariasikan warna berdasarkan kebutuhan. Tentukan warna pada tingkat NavigationSuiteScaffold untuk menggunakan instance objek yang sama pada semua item dan panggil fungsi NavigationSuiteDefaults.itemColors() untuk mengganti hanya item yang ingin Anda ubah:

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...
}
SampleNavigationSuiteScaffold.kt

Menyesuaikan jenis navigasi

Perilaku default NavigationSuiteScaffold mengubah UI navigasi berdasarkan class ukuran jendela. Namun, Anda mungkin perlu mengganti perilaku ini. Misalnya, jika aplikasi Anda menampilkan satu panel konten yang besar untuk feed, aplikasi tersebut dapat menggunakan panel navigasi permanen untuk jendela yang diperluas, tetapi masih kembali ke perilaku default untuk class ukuran jendela ringkas dan sedang:

val adaptiveInfo = currentWindowAdaptiveInfo()
val customNavSuiteType = with(adaptiveInfo) {
    if (windowSizeClass.windowWidthSizeClass == WindowWidthSizeClass.EXPANDED) {
        NavigationSuiteType.NavigationDrawer
    } else {
        NavigationSuiteScaffoldDefaults.calculateFromAdaptiveInfo(adaptiveInfo)
    }
}

NavigationSuiteScaffold(
    navigationSuiteItems = { /* ... */ },
    layoutType = customNavSuiteType,
) {
    // Content...
}
SampleNavigationSuiteScaffold.kt

Referensi tambahan

Lihat panduan Desain Material:

• Menu navigasi
• Kolom samping navigasi
• Panel navigasi

Lihat komponen library androidx.compose.material3 berikut:

• NavigationBar
• NavigationRail
• ModalNavigationDrawer
• PermanentNavigationDrawer