CheckboxDefaults - API Reference Item in Material 3 Compose

Common

object CheckboxDefaults

Defaults used in Checkbox and TriStateCheckbox.

Properties

Common

val StrokeWidth = 2.dp

The default stroke width for a Checkbox. This width will be used for the checkmark when the Checkbox is in a checked or indeterminate states, or for the outline when it's unchecked.

Functions

@Composable fun colors() = MaterialTheme.colorScheme.defaultCheckboxColors

Creates a CheckboxColors that will animate between the provided colors according to the Material specification.

colors

@Composable
    fun colors(
        checkedColor: Color = Color.Unspecified,
        uncheckedColor: Color = Color.Unspecified,
        checkmarkColor: Color = Color.Unspecified,
        disabledCheckedColor: Color = Color.Unspecified,
        disabledUncheckedColor: Color = Color.Unspecified,
        disabledIndeterminateColor: Color = Color.Unspecified,
    ): CheckboxColors

Creates a CheckboxColors that will animate between the provided colors according to the Material specification.

Parameters


checkedColor	the color that will be used for the border and box when checked
uncheckedColor	color that will be used for the border when unchecked. By default, the inner box is transparent when unchecked.
checkmarkColor	color that will be used for the checkmark when checked
disabledCheckedColor	color that will be used for the box and border when disabled and checked
disabledUncheckedColor	color that will be used for the border when disabled and unchecked. By default, the inner box is transparent when unchecked.
disabledIndeterminateColor	color that will be used for the box and border in a TriStateCheckbox when disabled AND in an ToggleableState.Indeterminate state

colors

@Composable
    fun colors(
        checkedCheckmarkColor: Color = Color.Unspecified,
        uncheckedCheckmarkColor: Color = Color.Unspecified,
        disabledCheckmarkColor: Color = Color.Unspecified,
        checkedBoxColor: Color = Color.Unspecified,
        uncheckedBoxColor: Color = Color.Unspecified,
        disabledCheckedBoxColor: Color = Color.Unspecified,
        disabledUncheckedBoxColor: Color = Color.Unspecified,
        disabledIndeterminateBoxColor: Color = Color.Unspecified,
        checkedBorderColor: Color = Color.Unspecified,
        uncheckedBorderColor: Color = Color.Unspecified,
        disabledBorderColor: Color = Color.Unspecified,
        disabledUncheckedBorderColor: Color = Color.Unspecified,
        disabledIndeterminateBorderColor: Color = Color.Unspecified,
    ): CheckboxColors

Creates a CheckboxColors that will animate between the provided colors according to the Material specification.

Parameters


checkedCheckmarkColor	color that will be used for the checkmark when checked
uncheckedCheckmarkColor	color that will be used for the checkmark when unchecked
disabledCheckmarkColor	color that will be used for the checkmark when disabled
checkedBoxColor	the color that will be used for the box when checked
uncheckedBoxColor	color that will be used for the box when unchecked
disabledCheckedBoxColor	color that will be used for the box when disabled and checked
disabledUncheckedBoxColor	color that will be used for the box when disabled and unchecked
disabledIndeterminateBoxColor	color that will be used for the box and border in a TriStateCheckbox when disabled AND in an ToggleableState.Indeterminate state.
checkedBorderColor	color that will be used for the border when checked
uncheckedBorderColor	color that will be used for the border when unchecked
disabledBorderColor	color that will be used for the border when disabled and checked
disabledUncheckedBorderColor	color that will be used for the border when disabled and unchecked
disabledIndeterminateBorderColor	color that will be used for the border when disabled and in an ToggleableState.Indeterminate state.