Compose Multiplatform Material3/androidx.compose.material3/Switch

Switch

@Composable
fun Switch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, thumbContent: @Composable () -> Unit? = null, enabled: Boolean = true, colors: SwitchColors = SwitchDefaults.colors(), interactionSource: MutableInteractionSource? = null)

Material Design Switch.

Switches toggle the state of a single item on or off.

Switch image

Parameters

checked

whether or not this switch is checked

onCheckedChange

called when this switch is clicked. If null, then this switch will not be interactable, unless something else handles its input events and updates its state.

modifier

the Modifier to be applied to this switch

thumbContent

content that will be drawn inside the thumb, expected to measure SwitchDefaults.IconSize

enabled

controls the enabled state of this switch. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.

colors

SwitchColors that will be used to resolve the colors used for this switch in different states. See SwitchDefaults.colors.

interactionSource

an optional hoisted MutableInteractionSource for observing and emitting Interactions for this switch. You can use this to change the switch's appearance or preview the switch in different states. Note that if null is provided, interactions will still happen internally.

Samples

androidx.compose.material3.samples.SwitchSampleandroidx.compose.material3.samples.SwitchWithThumbIconSample