CheckboxColors

class CheckboxColors


Represents the colors used by the three different sections (checkmark, box, and border) of a Checkbox or TriStateCheckbox in different states.

See CheckboxDefaults.colors for the default implementation that follows Material specifications.

Summary

Public constructors

CheckboxColors(
    checkedCheckmarkColor: Color,
    uncheckedCheckmarkColor: Color,
    checkedBoxColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedBoxColor: Color,
    disabledUncheckedBoxColor: Color,
    disabledIndeterminateBoxColor: Color,
    checkedBorderColor: Color,
    uncheckedBorderColor: Color,
    disabledBorderColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledIndeterminateBorderColor: Color
)

create an instance with arbitrary colors, see CheckboxDefaults.colors for the default implementation that follows Material specifications.

Public functions

CheckboxColors
copy(
    checkedCheckmarkColor: Color,
    uncheckedCheckmarkColor: Color,
    checkedBoxColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedBoxColor: Color,
    disabledUncheckedBoxColor: Color,
    disabledIndeterminateBoxColor: Color,
    checkedBorderColor: Color,
    uncheckedBorderColor: Color,
    disabledBorderColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledIndeterminateBorderColor: Color
)

Returns a copy of this CheckboxColors, optionally overriding some of the values.

open operator Boolean
equals(other: Any?)
open Int

Public properties

Color

color that will be used for the border when checked

Color

the color that will be used for the box when checked

Color

color that will be used for the checkmark when checked

Color

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

Color

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

Color

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

Color

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

Color

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

Color

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

Color

color that will be used for the border when unchecked

Color

color that will be used for the box when unchecked

Color

color that will be used for the checkmark when unchecked

Public constructors

CheckboxColors

CheckboxColors(
    checkedCheckmarkColor: Color,
    uncheckedCheckmarkColor: Color,
    checkedBoxColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedBoxColor: Color,
    disabledUncheckedBoxColor: Color,
    disabledIndeterminateBoxColor: Color,
    checkedBorderColor: Color,
    uncheckedBorderColor: Color,
    disabledBorderColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledIndeterminateBorderColor: Color
)

create an instance with arbitrary colors, see CheckboxDefaults.colors for the default implementation that follows Material specifications.

Parameters
checkedCheckmarkColor: Color

color that will be used for the checkmark when checked

uncheckedCheckmarkColor: Color

color that will be used for the checkmark when unchecked

checkedBoxColor: Color

the color that will be used for the box when checked

uncheckedBoxColor: Color

color that will be used for the box when unchecked

disabledCheckedBoxColor: Color

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

disabledUncheckedBoxColor: Color

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

disabledIndeterminateBoxColor: Color

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

checkedBorderColor: Color

color that will be used for the border when checked

uncheckedBorderColor: Color

color that will be used for the border when unchecked

disabledBorderColor: Color

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

disabledUncheckedBorderColor: Color

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

disabledIndeterminateBorderColor: Color

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

Public functions

copy

fun copy(
    checkedCheckmarkColor: Color = this.checkedCheckmarkColor,
    uncheckedCheckmarkColor: Color = this.uncheckedCheckmarkColor,
    checkedBoxColor: Color = this.checkedBoxColor,
    uncheckedBoxColor: Color = this.uncheckedBoxColor,
    disabledCheckedBoxColor: Color = this.disabledCheckedBoxColor,
    disabledUncheckedBoxColor: Color = this.disabledUncheckedBoxColor,
    disabledIndeterminateBoxColor: Color = this.disabledIndeterminateBoxColor,
    checkedBorderColor: Color = this.checkedBorderColor,
    uncheckedBorderColor: Color = this.uncheckedBorderColor,
    disabledBorderColor: Color = this.disabledBorderColor,
    disabledUncheckedBorderColor: Color = this.disabledUncheckedBorderColor,
    disabledIndeterminateBorderColor: Color = this.disabledIndeterminateBorderColor
): CheckboxColors

Returns a copy of this CheckboxColors, optionally overriding some of the values. This uses the Color.Unspecified to mean “use the value from the source”

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

checkedBorderColor

Added in 1.0.0
val checkedBorderColorColor

color that will be used for the border when checked

checkedBoxColor

Added in 1.0.0
val checkedBoxColorColor

the color that will be used for the box when checked

checkedCheckmarkColor

Added in 1.0.0
val checkedCheckmarkColorColor

color that will be used for the checkmark when checked

disabledBorderColor

Added in 1.0.0
val disabledBorderColorColor

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

disabledCheckedBoxColor

Added in 1.0.0
val disabledCheckedBoxColorColor

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

disabledIndeterminateBorderColor

Added in 1.0.0
val disabledIndeterminateBorderColorColor

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

disabledIndeterminateBoxColor

Added in 1.0.0
val disabledIndeterminateBoxColorColor

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

disabledUncheckedBorderColor

Added in 1.0.0
val disabledUncheckedBorderColorColor

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

disabledUncheckedBoxColor

Added in 1.0.0
val disabledUncheckedBoxColorColor

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

uncheckedBorderColor

Added in 1.0.0
val uncheckedBorderColorColor

color that will be used for the border when unchecked

uncheckedBoxColor

Added in 1.0.0
val uncheckedBoxColorColor

color that will be used for the box when unchecked

uncheckedCheckmarkColor

Added in 1.0.0
val uncheckedCheckmarkColorColor

color that will be used for the checkmark when unchecked