CheckboxDefaults


Defaults used in Checkbox and TriStateCheckbox.

Summary

Public functions

CheckboxColors

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

Cmn
CheckboxColors
@Composable
colors(
    checkedColor: Color,
    uncheckedColor: Color,
    checkmarkColor: Color,
    disabledCheckedColor: Color,
    disabledUncheckedColor: Color,
    disabledIndeterminateColor: Color
)

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

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

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

Cmn

Public properties

Dp

The default stroke width for a Checkbox.

Cmn

Public functions

colors

@Composable
fun colors(): CheckboxColors

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: Color = Color.Unspecified

the color that will be used for the border and box when checked

uncheckedColor: Color = Color.Unspecified

color that will be used for the border when unchecked. By default, the inner box is transparent when unchecked.

checkmarkColor: Color = Color.Unspecified

color that will be used for the checkmark when checked

disabledCheckedColor: Color = Color.Unspecified

color that will be used for the box and border when disabled and checked

disabledUncheckedColor: Color = Color.Unspecified

color that will be used for the border when disabled and unchecked. By default, the inner box is transparent when unchecked.

disabledIndeterminateColor: Color = Color.Unspecified

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 = Color.Unspecified

color that will be used for the checkmark when checked

uncheckedCheckmarkColor: Color = Color.Unspecified

color that will be used for the checkmark when unchecked

disabledCheckmarkColor: Color = Color.Unspecified

color that will be used for the checkmark when disabled

checkedBoxColor: Color = Color.Unspecified

the color that will be used for the box when checked

uncheckedBoxColor: Color = Color.Unspecified

color that will be used for the box when unchecked

disabledCheckedBoxColor: Color = Color.Unspecified

color that will be used for the box when disabled and checked

disabledUncheckedBoxColor: Color = Color.Unspecified

color that will be used for the box when disabled and unchecked

disabledIndeterminateBoxColor: Color = Color.Unspecified

color that will be used for the box and border in a TriStateCheckbox when disabled AND in an ToggleableState.Indeterminate state.

checkedBorderColor: Color = Color.Unspecified

color that will be used for the border when checked

uncheckedBorderColor: Color = Color.Unspecified

color that will be used for the border when unchecked

disabledBorderColor: Color = Color.Unspecified

color that will be used for the border when disabled and checked

disabledUncheckedBorderColor: Color = Color.Unspecified

color that will be used for the border when disabled and unchecked

disabledIndeterminateBorderColor: Color = Color.Unspecified

color that will be used for the border when disabled and in an ToggleableState.Indeterminate state.

Public properties

StrokeWidth

val StrokeWidthDp

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.