← Compose Multiplatform Component in Tv Material Compose
Switch
Android
Switches toggle the state of a single item on or off.
Switch can be used with a custom icon via [thumbContent] parameter
Last updated:
Installation
dependencies {
implementation("androidx.tv:tv-material:1.0.0-beta01")
}
Overloads
@Suppress("ComposableLambdaParameterNaming", "ComposableLambdaParameterPosition"
@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,
)
Parameters
| name | description |
|---|---|
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 [Interaction]s 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. |
Code Example
SwitchSample
@Composable
@Sampled
fun SwitchSample() {
Switch(checked = true, onCheckedChange = { })
}
