← Compose Multiplatform Component in Tv Material Compose
Checkbox
Android
Checkboxes allow users to select one or more items from a set. Checkboxes can turn an option on or off.
Last updated:
Installation
dependencies {
implementation("androidx.tv:tv-material:1.0.0-beta01")
}
Overloads
@Composable
fun Checkbox(
checked: Boolean,
onCheckedChange: ((Boolean) -> Unit)?,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: CheckboxColors = CheckboxDefaults.colors(),
interactionSource: MutableInteractionSource? = null
)
Parameters
| name | description |
|---|---|
checked | whether this checkbox is checked or unchecked |
onCheckedChange | 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 | the [Modifier] to be applied to this checkbox |
enabled | 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] that will be used to resolve the colors used for this checkbox in different states. See [CheckboxDefaults.colors]. |
interactionSource | an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s 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. |
Code Example
CheckboxSample
@Composable
@Sampled
fun CheckboxSample() {
Checkbox(checked = true, onCheckedChange = { })
}
