Toggles
Toggles

Pin

Pin toggle filling and rotating slightly when an item is pinned.

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 PinToggle() {
  var pinned by remember { mutableStateOf(false) }
  val rotation by animateFloatAsState(
    targetValue = if (pinned) -20f else 0f,
    label = "pinRotation",
  )
  IconToggleButton(
    checked = pinned,
    onCheckedChange = { pinned = it },
  ) {
    Icon(
      imageVector = if (pinned)
        Icons.Default.PushPin
      else
        Icons.Outlined.PushPin,
      contentDescription = null,
      tint = if (pinned)
        MaterialTheme.colorScheme.primary
      else
        MaterialTheme.colorScheme.onSurfaceVariant,
      modifier = Modifier.graphicsLayer {
        rotationZ = rotation
      },
    )
  }
}