Material Design checkbox.
Android
@Composable
fun Checkbox(
checked: Boolean,
onCheckedChange: ((Boolean) -> Unit)?,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: CheckboxColors = CheckboxDefaults.colors(),
interactionSource: MutableInteractionSource? = null,
)Parameters
| 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 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. |
Code Examples
CheckboxSample
@Composable
fun CheckboxSample() {
Checkbox(checked = true, onCheckedChange = {})
}
