OutlinedIconToggleButton

Component in Material 3 Compose

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.

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.compose.material3:material3:1.4.0-alpha02")
}

Overloads

@Composable
fun OutlinedIconToggleButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    shape: Shape = IconButtonDefaults.outlinedShape,
    colors: IconToggleButtonColors =
        IconButtonDefaults.outlinedIconToggleButtonLocalContentColors(),
    border: BorderStroke? =
        IconButtonDefaults.outlinedIconToggleButtonLocalContentColorBorder(enabled, checked),
    interactionSource: MutableInteractionSource? = null,
    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] and [IconButtonDefaults.outlinedIconToggleButtonLocalContentColors].
border	the border to draw around the container of this icon button. Pass null for no border. See [IconButtonDefaults.outlinedIconToggleButtonBorder] and [IconButtonDefaults.outlinedIconToggleButtonLocalContentColorBorder].
interactionSource	an 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.
content	the content of this icon button, typically an [Icon]

@ExperimentalMaterial3ExpressiveApi
@Composable
fun OutlinedIconToggleButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    shapes: IconButtonShapes,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    colors: IconToggleButtonColors = IconButtonDefaults.outlinedIconToggleButtonColors(),
    border: BorderStroke? = IconButtonDefaults.outlinedIconToggleButtonBorder(enabled, checked),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable () -> Unit
)

Parameters

name	description
checked	whether this icon button is toggled on or off
onCheckedChange	called when this icon button is clicked
shapes	the [IconButtonShapes] that the icon toggle button will morph between depending on the user's interaction with the icon toggle button.
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.outlinedIconToggleButtonColors].
border	the border to draw around the container of this icon button. Pass null for no border. See [IconButtonDefaults.outlinedIconToggleButtonBorder].
interactionSource	an 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.
content	the content of this icon button, typically an [Icon]

Code Examples

OutlinedIconToggleButtonSample

@Preview
@Composable
fun OutlinedIconToggleButtonSample() {
    var checked by remember { mutableStateOf(false) }
    OutlinedIconToggleButton(checked = checked, onCheckedChange = { checked = it }) {
        if (checked) {
            Icon(Icons.Filled.Lock, contentDescription = "Localized description")
        } else {
            Icon(Icons.Outlined.Lock, contentDescription = "Localized description")
        }
    }
}

OutlinedIconToggleButtonWithAnimatedShapeSample

@OptIn(ExperimentalMaterial3ExpressiveApi::class)
@Preview
@Composable
fun OutlinedIconToggleButtonWithAnimatedShapeSample() {
    var checked by remember { mutableStateOf(false) }
    OutlinedIconToggleButton(
        checked = checked,
        onCheckedChange = { checked = it },
        shapes =
            IconButtonShapes(
                shape = IconButtonDefaults.smallRoundShape,
                pressedShape = IconButtonDefaults.smallPressedShape,
                checkedShape = IconButtonDefaults.smallSquareShape,
            )
    ) {
        if (checked) {
            Icon(Icons.Filled.Lock, contentDescription = "Localized description")
        } else {
            Icon(Icons.Outlined.Lock, contentDescription = "Localized description")
        }
    }
}