Toggles
Toggles

Filter Chip

Selectable filter chip that reveals a leading check when active.

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 FilterChipToggle() {
  var selected by remember { mutableStateOf(true) }
  FilterChip(
    selected = selected,
    onClick = { selected = !selected },
    label = {
      Icon(
        Icons.Default.Star,
        contentDescription = null,
        modifier = Modifier.size(18.dp),
      )
    },
    leadingIcon = if (selected) {
      {
        Icon(
          Icons.Default.Check,
          contentDescription = null,
          modifier = Modifier.size(
            FilterChipDefaults.IconSize,
          ),
        )
      }
    } else null,
  )
}