CheckboxDefaults

@ExperimentalTvMaterial3Api
object CheckboxDefaults

Defaults used in Checkbox and TriStateCheckbox.

Summary

Public functions
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.

Public functions

colors

@Composable
fun colors(
    checkedColor: Color = MaterialTheme.colorScheme.fromToken(CheckboxTokens.SelectedContainerColor),
    uncheckedColor: Color = MaterialTheme.colorScheme.fromToken(CheckboxTokens.UnselectedOutlineColor),
    checkmarkColor: Color = MaterialTheme.colorScheme.fromToken(CheckboxTokens.SelectedIconColor),
    disabledCheckedColor: Color = MaterialTheme.colorScheme
                .fromToken(CheckboxTokens.SelectedDisabledContainerColor)
                .copy(alpha = CheckboxTokens.SelectedDisabledContainerOpacity),
    disabledUncheckedColor: Color = MaterialTheme.colorScheme
                .fromToken(CheckboxTokens.UnselectedDisabledOutlineColor)
                .copy(alpha = CheckboxTokens.UnselectedDisabledContainerOpacity),
    disabledIndeterminateColor: Color = disabledCheckedColor
): CheckboxColors

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

Parameters
checkedColor: Color = MaterialTheme.colorScheme.fromToken(CheckboxTokens.SelectedContainerColor)

the color that will be used for the border and box when checked
uncheckedColor: Color = MaterialTheme.colorScheme.fromToken(CheckboxTokens.UnselectedOutlineColor)

color that will be used for the border when unchecked
checkmarkColor: Color = MaterialTheme.colorScheme.fromToken(CheckboxTokens.SelectedIconColor)

color that will be used for the checkmark when checked
disabledCheckedColor: Color = MaterialTheme.colorScheme .fromToken(CheckboxTokens.SelectedDisabledContainerColor) .copy(alpha = CheckboxTokens.SelectedDisabledContainerOpacity)

color that will be used for the box and border when disabled and checked
disabledUncheckedColor: Color = MaterialTheme.colorScheme .fromToken(CheckboxTokens.UnselectedDisabledOutlineColor) .copy(alpha = CheckboxTokens.UnselectedDisabledContainerOpacity)

color that will be used for the box and border when disabled and not checked
disabledIndeterminateColor: Color = disabledCheckedColor

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