Toggles
Toggles

Tri-State

Parent checkbox cycling through checked, indeterminate, and empty states.

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 TriStateToggle() {
  val children = remember {
    mutableStateListOf(true, false)
  }
  val parent = when {
    children.all { it } -> ToggleableState.On
    children.none { it } -> ToggleableState.Off
    else -> ToggleableState.Indeterminate
  }
  TriStateCheckbox(
    state = parent,
    onClick = {
      val target = parent != ToggleableState.On
      children.indices.forEach { children[it] = target }
    },
  )
}