CheckboxButtonDefaults

object CheckboxButtonDefaults


Contains the default values used by CheckboxButtons and SplitCheckboxButtons

Summary

Public functions

CheckboxButtonColors

Creates a CheckboxButtonColors for use in a CheckboxButton.

CheckboxButtonColors
@Composable
checkboxButtonColors(
    checkedContainerColor: Color,
    checkedContentColor: Color,
    checkedSecondaryContentColor: Color,
    checkedIconColor: Color,
    checkedBoxColor: Color,
    checkedCheckmarkColor: Color,
    uncheckedContainerColor: Color,
    uncheckedContentColor: Color,
    uncheckedSecondaryContentColor: Color,
    uncheckedIconColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedContainerColor: Color,
    disabledCheckedContentColor: Color,
    disabledCheckedSecondaryContentColor: Color,
    disabledCheckedIconColor: Color,
    disabledCheckedBoxColor: Color,
    disabledCheckedCheckmarkColor: Color,
    disabledUncheckedContainerColor: Color,
    disabledUncheckedContentColor: Color,
    disabledUncheckedSecondaryContentColor: Color,
    disabledUncheckedIconColor: Color,
    disabledUncheckedBoxColor: Color
)

Creates a CheckboxButtonColors for use in a CheckboxButton.

SplitCheckboxButtonColors

Creates a SplitCheckboxButtonColors for use in a SplitCheckboxButton.

SplitCheckboxButtonColors
@Composable
splitCheckboxButtonColors(
    checkedContainerColor: Color,
    checkedContentColor: Color,
    checkedSecondaryContentColor: Color,
    checkedSplitContainerColor: Color,
    checkedBoxColor: Color,
    checkedCheckmarkColor: Color,
    uncheckedContainerColor: Color,
    uncheckedContentColor: Color,
    uncheckedSecondaryContentColor: Color,
    uncheckedSplitContainerColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedContainerColor: Color,
    disabledCheckedContentColor: Color,
    disabledCheckedSecondaryContentColor: Color,
    disabledCheckedSplitContainerColor: Color,
    disabledCheckedBoxColor: Color,
    disabledCheckedCheckmarkColor: Color,
    disabledUncheckedContainerColor: Color,
    disabledUncheckedContentColor: Color,
    disabledUncheckedSecondaryContentColor: Color,
    disabledUncheckedSplitContainerColor: Color,
    disabledUncheckedBoxColor: Color
)

Creates a SplitCheckboxButtonColors for use in a SplitCheckboxButton.

Public properties

PaddingValues

The default content padding used by CheckboxButton

Shape

Recommended Shape for CheckboxButton.

Shape

Recommended Shape for SplitCheckboxButton.

Public functions

checkboxButtonColors

Added in 1.5.0
@Composable
fun checkboxButtonColors(): CheckboxButtonColors

Creates a CheckboxButtonColors for use in a CheckboxButton.

checkboxButtonColors

@Composable
fun checkboxButtonColors(
    checkedContainerColor: Color = Color.Unspecified,
    checkedContentColor: Color = Color.Unspecified,
    checkedSecondaryContentColor: Color = Color.Unspecified,
    checkedIconColor: Color = Color.Unspecified,
    checkedBoxColor: Color = Color.Unspecified,
    checkedCheckmarkColor: Color = Color.Unspecified,
    uncheckedContainerColor: Color = Color.Unspecified,
    uncheckedContentColor: Color = Color.Unspecified,
    uncheckedSecondaryContentColor: Color = Color.Unspecified,
    uncheckedIconColor: Color = Color.Unspecified,
    uncheckedBoxColor: Color = Color.Unspecified,
    disabledCheckedContainerColor: Color = Color.Unspecified,
    disabledCheckedContentColor: Color = Color.Unspecified,
    disabledCheckedSecondaryContentColor: Color = Color.Unspecified,
    disabledCheckedIconColor: Color = Color.Unspecified,
    disabledCheckedBoxColor: Color = Color.Unspecified,
    disabledCheckedCheckmarkColor: Color = Color.Unspecified,
    disabledUncheckedContainerColor: Color = Color.Unspecified,
    disabledUncheckedContentColor: Color = Color.Unspecified,
    disabledUncheckedSecondaryContentColor: Color = Color.Unspecified,
    disabledUncheckedIconColor: Color = Color.Unspecified,
    disabledUncheckedBoxColor: Color = Color.Unspecified
): CheckboxButtonColors

Creates a CheckboxButtonColors for use in a CheckboxButton.

Parameters
checkedContainerColor: Color = Color.Unspecified

The container color of the CheckboxButton when enabled and checked.

checkedContentColor: Color = Color.Unspecified

The content color of the CheckboxButton when enabled and checked.

checkedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of the CheckboxButton when enabled and checked, used for secondaryLabel content.

checkedIconColor: Color = Color.Unspecified

The icon color of the CheckboxButton when enabled and checked.

checkedBoxColor: Color = Color.Unspecified

The box color of the checkbox when enabled and checked.

checkedCheckmarkColor: Color = Color.Unspecified

The checkmark color of the checkbox when enabled and checked.

uncheckedContainerColor: Color = Color.Unspecified

The container color of the CheckboxButton when enabled and unchecked.

uncheckedContentColor: Color = Color.Unspecified

The content color of a CheckboxButton when enabled and unchecked.

uncheckedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of this CheckboxButton when enabled and unchecked, used for secondaryLabel content

uncheckedIconColor: Color = Color.Unspecified

The icon color of the CheckboxButton when enabled and unchecked.

uncheckedBoxColor: Color = Color.Unspecified

The box color of the checkbox when enabled and unchecked.

disabledCheckedContainerColor: Color = Color.Unspecified

The container color of the CheckboxButton when disabled and checked.

disabledCheckedContentColor: Color = Color.Unspecified

The content color of the CheckboxButton when disabled and checked.

disabledCheckedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of the CheckboxButton when disabled and checked, used for secondaryLabel content.

disabledCheckedIconColor: Color = Color.Unspecified

The icon color of the CheckboxButton when disabled and checked.

disabledCheckedBoxColor: Color = Color.Unspecified

The box color of the checkbox when disabled and checked.

disabledCheckedCheckmarkColor: Color = Color.Unspecified

The checkmark color of the checkbox when disabled and checked.

disabledUncheckedContainerColor: Color = Color.Unspecified

The container color of the CheckboxButton when disabled and unchecked.

disabledUncheckedContentColor: Color = Color.Unspecified

The content color of a CheckboxButton when disabled and unchecked.

disabledUncheckedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of this CheckboxButton when disabled and unchecked, used for secondaryLabel content

disabledUncheckedIconColor: Color = Color.Unspecified

The icon color of the CheckboxButton when disabled and unchecked.

disabledUncheckedBoxColor: Color = Color.Unspecified

The box color of the checkbox when disabled and unchecked.

splitCheckboxButtonColors

Added in 1.5.0
@Composable
fun splitCheckboxButtonColors(): SplitCheckboxButtonColors

Creates a SplitCheckboxButtonColors for use in a SplitCheckboxButton.

splitCheckboxButtonColors

@Composable
fun splitCheckboxButtonColors(
    checkedContainerColor: Color = Color.Unspecified,
    checkedContentColor: Color = Color.Unspecified,
    checkedSecondaryContentColor: Color = Color.Unspecified,
    checkedSplitContainerColor: Color = Color.Unspecified,
    checkedBoxColor: Color = Color.Unspecified,
    checkedCheckmarkColor: Color = Color.Unspecified,
    uncheckedContainerColor: Color = Color.Unspecified,
    uncheckedContentColor: Color = Color.Unspecified,
    uncheckedSecondaryContentColor: Color = Color.Unspecified,
    uncheckedSplitContainerColor: Color = Color.Unspecified,
    uncheckedBoxColor: Color = Color.Unspecified,
    disabledCheckedContainerColor: Color = Color.Unspecified,
    disabledCheckedContentColor: Color = Color.Unspecified,
    disabledCheckedSecondaryContentColor: Color = Color.Unspecified,
    disabledCheckedSplitContainerColor: Color = Color.Unspecified,
    disabledCheckedBoxColor: Color = Color.Unspecified,
    disabledCheckedCheckmarkColor: Color = Color.Unspecified,
    disabledUncheckedContainerColor: Color = Color.Unspecified,
    disabledUncheckedContentColor: Color = Color.Unspecified,
    disabledUncheckedSecondaryContentColor: Color = Color.Unspecified,
    disabledUncheckedSplitContainerColor: Color = Color.Unspecified,
    disabledUncheckedBoxColor: Color = Color.Unspecified
): SplitCheckboxButtonColors

Creates a SplitCheckboxButtonColors for use in a SplitCheckboxButton.

Parameters
checkedContainerColor: Color = Color.Unspecified

The container color of the SplitCheckboxButton when enabled and checked.

checkedContentColor: Color = Color.Unspecified

The content color of the SplitCheckboxButton when enabled and checked.

checkedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of the SplitCheckboxButton when enabled and checked, used for secondaryLabel content.

checkedSplitContainerColor: Color = Color.Unspecified

The split container color of the SplitCheckboxButton when enabled and checked.

checkedBoxColor: Color = Color.Unspecified

The box color of the SplitCheckboxButton when enabled and checked.

checkedCheckmarkColor: Color = Color.Unspecified

The checkmark color of the SplitCheckboxButton when enabled and checked

uncheckedContainerColor: Color = Color.Unspecified

The container color of the SplitCheckboxButton when enabled and unchecked.

uncheckedContentColor: Color = Color.Unspecified

The content color of the SplitCheckboxButton when enabled and unchecked.

uncheckedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of the SplitCheckboxButton when enabled and unchecked, used for secondaryLabel content.

uncheckedSplitContainerColor: Color = Color.Unspecified

The split container color of the SplitCheckboxButton when enabled and unchecked.

uncheckedBoxColor: Color = Color.Unspecified

The box color of the SplitCheckboxButton when enabled and unchecked

disabledCheckedContainerColor: Color = Color.Unspecified

The container color of the SplitCheckboxButton when disabled and checked.

disabledCheckedContentColor: Color = Color.Unspecified

The content color of the SplitCheckboxButton when disabled and checked.

disabledCheckedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of the SplitCheckboxButton when disabled and checked, used for secondaryLabel content.

disabledCheckedSplitContainerColor: Color = Color.Unspecified

The split container color of the SplitCheckboxButton when disabled and checked.

disabledCheckedBoxColor: Color = Color.Unspecified

The box color of the SplitCheckboxButton when disabled and checked.

disabledCheckedCheckmarkColor: Color = Color.Unspecified

The checkmark color of the SplitCheckboxButton when disabled and checked.

disabledUncheckedContainerColor: Color = Color.Unspecified

The container color of the SplitCheckboxButton when disabled and unchecked.

disabledUncheckedContentColor: Color = Color.Unspecified

The content color of the SplitCheckboxButton when disabled and unchecked.

disabledUncheckedSecondaryContentColor: Color = Color.Unspecified

The secondary content color of the SplitCheckboxButton when disabled and unchecked, used for secondaryLabel content.

disabledUncheckedSplitContainerColor: Color = Color.Unspecified

The split container color of the SplitCheckboxButton when disabled and unchecked.

disabledUncheckedBoxColor: Color = Color.Unspecified

The box color of the SplitCheckboxButton when disabled and unchecked.

Public properties

ContentPadding

Added in 1.5.0
val ContentPaddingPaddingValues

The default content padding used by CheckboxButton

checkboxButtonShape

Added in 1.5.0
val checkboxButtonShapeShape

Recommended Shape for CheckboxButton.

splitCheckboxButtonShape

Added in 1.5.0
val splitCheckboxButtonShapeShape

Recommended Shape for SplitCheckboxButton.