Togglesanimated

Lock Button

Round button morphing between locked and unlocked padlock glyphs.

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 LockButtonToggle() {
  var locked by remember { mutableStateOf(true) }
  FilledTonalIconToggleButton(
    checked = locked,
    onCheckedChange = { locked = it },
  ) {
    AnimatedContent(targetState = locked, label = "lock") {
      Icon(
        imageVector = if (it)
          Icons.Filled.Lock
        else
          Icons.Filled.LockOpen,
        contentDescription = null,
      )
    }
  }
}