Navigation rail

A vertical rail of destinations with a tinted pill behind the active icon.

Home

Browse

Settings

Installation

caveui components are copy-paste Jetpack Compose built entirely on Material 3 — there's no caveui dependency to add. Make sure Material 3 is on your classpath (it ships with the Compose BOM), then copy the Usage snippet below into your project.

kotlin

// build.gradle.kts (module)
dependencies {
    implementation(platform("androidx.compose:compose-bom:2025.06.00"))
    implementation("androidx.compose.material3:material3")
}

Usage

kotlin

@Composable
fun Rail() {
    var selected by remember { mutableStateOf(0) }
    val items = listOf(
        Icons.Filled.Home to "Home",
        Icons.Filled.GridView to "Browse",
        Icons.Filled.Settings to "Settings",
    )
    NavigationRail {
        items.forEachIndexed { i, (icon, label) ->
            NavigationRailItem(
                selected = i == selected,
                onClick = { selected = i },
                icon = { Icon(icon, contentDescription = label) },
                label = { Text(label) },
            )
        }
    }
}