Togglesanimated

Favorite

Star toggle that fills amber and springs when marked as favorite.

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 StarToggle() {
  var starred by remember { mutableStateOf(false) }
  val scale by animateFloatAsState(
    targetValue = if (starred) 1.15f else 1f,
    animationSpec = spring(
      dampingRatio = Spring.DampingRatioMediumBouncy,
    ),
    label = "starScale",
  )
  IconToggleButton(
    checked = starred,
    onCheckedChange = { starred = it },
  ) {
    Icon(
      imageVector = if (starred)
        Icons.Default.Star
      else
        Icons.Default.StarBorder,
      contentDescription = null,
      tint = if (starred)
        MaterialTheme.colorScheme.tertiary
      else
        MaterialTheme.colorScheme.onSurfaceVariant,
      modifier = Modifier.graphicsLayer {
        scaleX = scale
        scaleY = scale
      },
    )
  }
}