Jetpack Compose OutlinedIconToggleButton in Compose Multiplatform

<a href="https://m3.material.io/components/icon-button/overview" class="external" target="_blank">Material Design outlined 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.

!Outlined icon toggle button image(https://developer.android.com/images/reference/androidx/compose/material3/outlined-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

OutlinedIconToggleButton

@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun OutlinedIconToggleButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    shape: Shape = IconButtonDefaults.outlinedShape,
    colors: IconToggleButtonColors = IconButtonDefaults.outlinedIconToggleButtonColors(),
    border: BorderStroke? = IconButtonDefaults.outlinedIconToggleButtonBorder(enabled, checked),
    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.
`shape`	defines the shape of this icon button's container and border (when border is not null)
`colors`	IconToggleButtonColors that will be used to resolve the colors used for this icon button in different states. See IconButtonDefaults.outlinedIconToggleButtonColors.
`border`	the border to draw around the container of this icon button. Pass `null` for no border. See IconButtonDefaults.outlinedIconToggleButtonBorder.
`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

← Back to Compose Multiplatform

OutlinedIconToggleButton

Overloads

OutlinedIconToggleButton

Parameters