Compose Multiplatform Material3/androidx.compose.material3/TriStateCheckbox

TriStateCheckbox

@Composable
fun TriStateCheckbox(state: ToggleableState, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, colors: CheckboxColors = CheckboxDefaults.colors(), interactionSource: MutableInteractionSource? = null)

Material Design checkbox

Checkboxes can have a parent-child relationship with other checkboxes. When the parent checkbox is checked, all child checkboxes are checked. If a parent checkbox is unchecked, all child checkboxes are unchecked. If some, but not all, child checkboxes are checked, the parent checkbox becomes an indeterminate checkbox.

Checkbox image

Parameters

state

whether this checkbox is checked, unchecked, or in an indeterminate state

onClick

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.

See also

if you want a simple component that represents Boolean state

Samples

androidx.compose.material3.samples.TriStateCheckboxSample
@Composable
fun TriStateCheckbox(state: ToggleableState, onClick: () -> Unit?, checkmarkStroke: Stroke, outlineStroke: Stroke, modifier: Modifier = Modifier, enabled: Boolean = true, colors: CheckboxColors = CheckboxDefaults.colors(), interactionSource: MutableInteractionSource? = null)

Material Design checkbox

Checkboxes can have a parent-child relationship with other checkboxes. When the parent checkbox is checked, all child checkboxes are checked. If a parent checkbox is unchecked, all child checkboxes are unchecked. If some, but not all, child checkboxes are checked, the parent checkbox becomes an indeterminate checkbox.

Checkbox image

This Checkbox function offers greater flexibility in visual customization. Using the Stroke parameters, you can control the appearance of both the checkmark and the box that surrounds it.

A sample of a TriStateCheckbox that uses a Stroke with rounded StrokeCap and androidx.compose.ui.graphics.StrokeJoin:

Parameters

state

whether this checkbox is checked, unchecked, or in an indeterminate state

onClick

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.

checkmarkStroke

stroke for the checkmark.

outlineStroke

stroke for the checkmark's box outline. Note that this stroke is applied when drawing the outline's rounded rectangle, so attributions such as androidx.compose.ui.graphics.StrokeJoin will be ignored.

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.

See also

if you want a simple component that represents Boolean state

Samples

androidx.compose.material3.samples.TriStateCheckboxRoundedStrokesSample