Checkbox

Functions summary

Unit	@Composable Checkbox(     checked: Boolean,     onCheckedChange: ((Boolean) -> Unit)?,     modifier: Modifier,     enabled: Boolean,     colors: CheckboxColors,     interactionSource: MutableInteractionSource? ) Material Design checkbox.

Functions

Checkbox

Artifact: androidx.tv:tv-material

View Source

Added in 1.0.0

@Composable
fun Checkbox(
    checked: Boolean,
    onCheckedChange: ((Boolean) -> Unit)?,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    colors: CheckboxColors = CheckboxDefaults.colors(),
    interactionSource: MutableInteractionSource? = null
): Unit

Material Design checkbox.

Checkboxes allow users to select one or more items from a set. Checkboxes can turn an option on or off.

import androidx.tv.material3.Checkbox

Checkbox(checked = true, onCheckedChange = {})

Parameters
checked: Boolean	whether this checkbox is checked or unchecked
onCheckedChange: ((Boolean) -> Unit)?	called when this checkbox is clicked. If null, then this checkbox will not be interactable, unless something else handles its input events and updates its state.
modifier: Modifier = Modifier	the Modifier to be applied to this checkbox
enabled: Boolean = true	controls the enabled state of this checkbox. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
colors: CheckboxColors = CheckboxDefaults.colors()	CheckboxColors that will be used to resolve the colors used for this checkbox in different states. See CheckboxDefaults.colors.
interactionSource: MutableInteractionSource? = null	an optional hoisted MutableInteractionSource for observing and emitting Interactions for this checkbox. You can use this to change the checkbox's appearance or preview the checkbox in different states. Note that if null is provided, interactions will still happen internally.

See also
TriStateCheckbox	if you require support for an indeterminate state.