API reference
API reference
Select your platform
No SDKs available
No versions available

SpatialSwitch Function

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

Signature

fun SpatialSwitch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, thumbContent: () -> Unit? = null, enabled: Boolean = true, colors: SwitchColors = SwitchDefaults.colors())

Parameters

checked: Boolean
whether or not this switch is checked
onCheckedChange: Function1?
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: Modifier
the Modifier to be applied to this switch
thumbContent: Function0?
content that will be drawn inside the thumb, expected to measure .CheckIconSize
enabled: Boolean
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
SwitchColors that will be used to resolve the colors used for this switch in different states. See SwitchDefaults.colors.
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta