Composable Component
Wear Material `ToggleButton` that offers a single slot to take any content (text, icon or image).
Android
> **Deprecated** This overload is provided for backwards compatibility with Compose for Wear OS 1.0.A newer overload is available with an additional shape parameter.
ToggleButton
```kotlin
@Composable
public fun ToggleButton(
checked: Boolean,
onCheckedChange: (Boolean) -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: ToggleButtonColors = ToggleButtonDefaults.toggleButtonColors(),
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
content: @Composable BoxScope.() -> Unit,
): Unit
```
#### Parameters
| | |
| --- | --- |
| checked | Boolean flag indicating whether this toggle button is currently checked. |
| onCheckedChange | Callback to be invoked when this toggle button is clicked. |
| modifier | Modifier to be applied to the toggle button. |
| enabled | Controls the enabled state of the toggle button. When `false`, this toggle button will not be clickable. |
| colors | `ToggleButtonColors` that will be used to resolve the background and content color for this toggle button. See `ToggleButtonDefaults.toggleButtonColors`. |
| interactionSource | The `MutableInteractionSource` representing the stream of `Interaction`s for this toggle button. You can create and pass in your own remembered `MutableInteractionSource` if you want to observe `Interaction`s and customize the appearance / behavior of this ToggleButton in different `Interaction`s. |
| content | The icon, image or text to be drawn inside the toggle button. |
Android
> **Deprecated** This overload is provided for backwards compatibility with Compose for Wear OS 1.1.A newer overload is available with an additional semantic role parameter.
ToggleButton
```kotlin
@Composable
public fun ToggleButton(
checked: Boolean,
onCheckedChange: (Boolean) -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: ToggleButtonColors = ToggleButtonDefaults.toggleButtonColors(),
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
shape: Shape = CircleShape,
content: @Composable BoxScope.() -> Unit,
): Unit
```
#### Parameters
| | |
| --- | --- |
| checked | Boolean flag indicating whether this toggle button is currently checked. |
| onCheckedChange | Callback to be invoked when this toggle button is clicked. |
| modifier | Modifier to be applied to the toggle button. |
| enabled | Controls the enabled state of the toggle button. When `false`, this toggle button will not be clickable. |
| colors | `ToggleButtonColors` that will be used to resolve the background and content color for this toggle button. See `ToggleButtonDefaults.toggleButtonColors`. |
| interactionSource | The `MutableInteractionSource` representing the stream of `Interaction`s for this toggle button. You can create and pass in your own remembered `MutableInteractionSource` if you want to observe `Interaction`s and customize the appearance / behavior of this ToggleButton in different `Interaction`s. |
| shape | Defines the shape for this toggle button. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material Theme. |
| content | The icon, image or text to be drawn inside the toggle button. |
ToggleButton
Android
```kotlin
@Composable
public fun ToggleButton(
checked: Boolean,
onCheckedChange: (Boolean) -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: ToggleButtonColors = ToggleButtonDefaults.toggleButtonColors(),
interactionSource: MutableInteractionSource? = null,
shape: Shape = CircleShape,
role: Role = ToggleButtonDefaults.DefaultRole,
content: @Composable BoxScope.() -> Unit,
)
```
#### Parameters
| | |
| --- | --- |
| checked | Boolean flag indicating whether this toggle button is currently checked. |
| onCheckedChange | Callback to be invoked when this toggle button is clicked. |
| modifier | Modifier to be applied to the toggle button. |
| enabled | Controls the enabled state of the toggle button. When `false`, this toggle button will not be clickable. |
| colors | `ToggleButtonColors` that will be used to resolve the background and content color for this toggle button. See `ToggleButtonDefaults.toggleButtonColors`. |
| 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. |
| shape | Defines the shape for this toggle button. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material Theme. |
| role | Role semantics that accessibility services can use to provide more context to users. |
| content | The icon, image or text to be drawn inside the toggle button. |