IconToggleButton

Common/AllAndroid/JVM

Functions summary

Unit

@Composable IconToggleButton(     checked: Boolean,     onCheckedChange: (Boolean) -> Unit,     modifier: Modifier,     enabled: Boolean,     interactionSource: MutableInteractionSource?,     content: @Composable () -> Unit ) An IconButton with two states, for icons that can be toggled 'on' and 'off', such as a bookmark icon, or a navigation icon that opens a drawer.

Cmn

Functions

IconToggleButton

Cmn

Artifact: androidx.compose.material:material

View Source

Added in 1.0.0

@Composable
fun IconToggleButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    interactionSource: MutableInteractionSource? = null,
    content: @Composable () -> Unit
): Unit

An IconButton with two states, for icons that can be toggled 'on' and 'off', such as a bookmark icon, or a navigation icon that opens a drawer.

import androidx.compose.animation.animateColorAsState
import androidx.compose.material.Icon
import androidx.compose.material.IconToggleButton
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Favorite
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.graphics.Color

var checked by remember { mutableStateOf(false) }

IconToggleButton(checked = checked, onCheckedChange = { checked = it }) {
    val tint by animateColorAsState(if (checked) Color(0xFFEC407A) else Color(0xFFB0BEC5))
    Icon(Icons.Filled.Favorite, contentDescription = "Localized description", tint = tint)
}

Parameters
checked: Boolean	whether this IconToggleButton is currently checked
onCheckedChange: (Boolean) -> Unit	callback to be invoked when this icon is selected
modifier: Modifier = Modifier	optional Modifier for this IconToggleButton
enabled: Boolean = true	enabled whether or not this IconToggleButton will handle input events and appear enabled for semantics purposes
interactionSource: MutableInteractionSource? = null	an optional hoisted MutableInteractionSource for observing and emitting Interactions for this IconButton. You can use this to change the IconButton's appearance or preview the IconButton in different states. Note that if null is provided, interactions will still happen internally.
content: @Composable () -> Unit	the content (icon) to be drawn inside the IconToggleButton. This is typically an Icon.