New Compose Multiplatform components arrived on Composables UICheck it out →

IconButton

Icon buttons help people take supplementary actions with a single tap. They’re used when a compact button is required, such as in a toolbar or image list.

Standard icon button
image

Last updated:

Installation

dependencies {
   implementation("androidx.compose.material3:material3:1.3.0-beta03")
}

Overloads

@Composable
fun IconButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    colors: IconButtonColors = IconButtonDefaults.iconButtonColors(),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable () -> Unit
)

Parameters

namedescription
onClickcalled when this icon button is clicked
modifierthe [Modifier] to be applied to this icon button
enabledcontrols the enabled state of this icon button. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
colors[IconButtonColors] that will be used to resolve the colors used for this icon button in different states. See [IconButtonDefaults.iconButtonColors].
interactionSourcean optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this icon button. You can use this to change the icon button's appearance or preview the icon button in different states. Note that if null is provided, interactions will still happen internally.
contentthe content of this icon button, typically an [Icon]

Code Examples

IconButtonSample

@Composable
@Sampled
@Preview
fun IconButtonSample() {
    IconButton(onClick = { /* doSomething() */ }) {
        Icon(Icons.Outlined.Lock, contentDescription = "Localized description")
    }
}

TintedIconButtonSample

@Composable
@Sampled
@Preview
@OptIn(ExperimentalMaterial3Api::class
fun TintedIconButtonSample() {
    IconButton(onClick = { /* doSomething() */ }) {
        Icon(
            rememberVectorPainter(image = Icons.Outlined.Lock),
            contentDescription = "Localized description",
            tint = { Color.Red }
        )
    }
}