<div class='type'>Composable Component</div>


Toggle button is a toggleable button that switches between primary and tonal colors depending on
`checked`'s value. It also morphs between the three shapes provided in `shapes` depending on the
state of the interaction with the toggle button as long as the three shapes provided our
`CornerBasedShape`s. If a shape in `shapes` isn't a `CornerBasedShape`, then toggle button will
toggle between the `ToggleButtonShapes` according to user interaction.

<a id='references'></a>


<h2 id="togglebutton-checked-oncheckedchange-modifier-enabled-shapes-colors-elevation-border-contentpadding-interactionsource-content">ToggleButton</h2>

<div class='sourceset sourceset-common'>Common</div>


```kotlin
@Composable
@ExperimentalMaterial3ExpressiveApi
fun ToggleButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    shapes: ToggleButtonShapes = ToggleButtonDefaults.shapesFor(ButtonDefaults.MinHeight),
    colors: ToggleButtonColors = ToggleButtonDefaults.toggleButtonColors(),
    elevation: ButtonElevation? = ButtonDefaults.buttonElevation(),
    border: BorderStroke? = null,
    contentPadding: PaddingValues = ButtonDefaults.contentPaddingFor(ButtonDefaults.MinHeight),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable RowScope.() -> Unit,
)
```


#### Parameters

| | |
| --- | --- |
| checked | whether the toggle button is toggled on or off. |
| onCheckedChange | called when the toggle button is clicked. |
| modifier | the `Modifier` to be applied to the toggle button. |
| enabled | controls the enabled state of this toggle button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services. |
| shapes | the `ToggleButtonShapes` that the toggle button will morph between depending on the user's interaction with the toggle button. |
| colors | `ToggleButtonColors` that will be used to resolve the colors used for this toggle button in different states. See `ToggleButtonDefaults.toggleButtonColors`. |
| elevation | `ButtonElevation` used to resolve the elevation for this button in different states. This controls the size of the shadow below the button. See `ButtonElevation.shadowElevation`. Additionally, when the container color is `ColorScheme.surface`, this controls the amount of primary color applied as an overlay. |
| border | the border to draw around the container of this toggle button. |
| contentPadding | the spacing values to apply internally between the container and the content |
| interactionSource | an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s for this toggle button. You can use this to change the toggle button's appearance or preview the toggle button in different states. Note that if `null` is provided, interactions will still happen internally. |
| content | The content displayed on the toggle button, expected to be text, icon or image. |