← Back to Material 3 Compose
IconToggleButton
Overview
Code Examples
Video
<a href="https://m3.material.io/components/icon-button/overview" class="external" target="_blank">Material Design standard icon toggle button</a>.
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 toggle button image(https://developer.android.com/images/reference/androidx/compose/material3/standard-icon-toggle-button.png)
content should typically be an Icon (see androidx.compose.material.icons.Icons). If using a custom icon, note that the typical size for the internal icon is 24 x 24 dp. This icon button has an overall minimum touch target size of 48 x 48dp, to meet accessibility guidelines.
Overloads
IconToggleButton
@Composable
fun IconToggleButton(
checked: Boolean,
onCheckedChange: (Boolean) -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: IconToggleButtonColors = IconButtonDefaults.iconToggleButtonColors(),
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
content: @Composable () -> Unit
)
Parameters
Name | Description |
---|---|
checked | whether this icon button is toggled on or off |
onCheckedChange | called when this icon button is clicked |
modifier | the Modifier to be applied to this icon button |
enabled | controls 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 | IconToggleButtonColors that will be used to resolve the colors used for this icon button in different states. See IconButtonDefaults.iconToggleButtonColors. |
interactionSource | the MutableInteractionSource representing the stream of Interactions for this icon button. You can create and pass in your own remember ed instance to observe Interactions and customize the appearance / behavior of this icon button in different states. |
content | the content of this icon button, typically an Icon |