State of Compose 2023 results are in! Click here to learn more

← Back to Material 3 Compose

Switch

Component
in
Material 3
. Since 1.0.0

Overview

Code Examples

Video

<a href="https://m3.material.io/components/switch" class="external" target="_blank">Material Design Switch</a>.

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

!Switch image(https://developer.android.com/images/reference/androidx/compose/material3/switch.png)

Overloads

Switch

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

Parameters

NameDescription
checkedwhether or not this switch is checked
onCheckedChangecalled 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.
modifierthe Modifier to be applied to this switch
thumbContentcontent that will be drawn inside the thumb, expected to measure SwitchDefaults.IconSize
enabledcontrols 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.
colorsSwitchColors that will be used to resolve the colors used for this switch in different states. See SwitchDefaults.colors.
interactionSourcethe MutableInteractionSource representing the stream of Interactions for this switch. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this switch in different states