# CheckboxColors

Artifact: [androidx.tv:tv-material](https://developer.android.com/jetpack/androidx/releases/tv) [View Source](https://cs.android.com/search?q=file:androidx/tv/material3/Checkbox.kt+class:androidx.tv.material3.CheckboxColors) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)


```
class CheckboxColors
```

<br />

*** ** * ** ***

Represents the colors used by the three different sections (checkmark, box, and border) of a `https://developer.android.com/reference/kotlin/androidx/tv/material3/Checkbox.composable#Checkbox(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.tv.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)` or `https://developer.android.com/reference/kotlin/androidx/tv/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.tv.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)` in different states.

See `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxDefaults#colors()` for the default implementation that follows Material specifications.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#CheckboxColors(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( checkedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledCheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledUncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledIndeterminateBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledUncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledIndeterminateBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` create an instance with arbitrary colors, see `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxDefaults#colors()` for the default implementation that follows Material specifications. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#copy(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( checkedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledCheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledUncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledIndeterminateBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledUncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledIndeterminateBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Returns a copy of this CheckboxColors, optionally overriding some of the values. |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#hashCode()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#checkedBorderColor()` color that will be used for the border when checked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#checkedBoxColor()` the color that will be used for the box when checked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#checkedCheckmarkColor()` color that will be used for the checkmark when checked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#disabledBorderColor()` color that will be used for the border when disabled and checked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#disabledCheckedBoxColor()` color that will be used for the box when disabled and checked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#disabledIndeterminateBorderColor()` color that will be used for the border when disabled and in an `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` state. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#disabledIndeterminateBoxColor()` color that will be used for the box and border in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.tv.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)` when disabled AND in an `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` state. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#disabledUncheckedBorderColor()` color that will be used for the border when disabled and unchecked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#disabledUncheckedBoxColor()` color that will be used for the box when disabled and unchecked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#uncheckedBorderColor()` color that will be used for the border when unchecked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#uncheckedBoxColor()` color that will be used for the box when unchecked |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors#uncheckedCheckmarkColor()` color that will be used for the checkmark when unchecked |

## Public constructors

### CheckboxColors

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tv#1.1.0)

```
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 `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxDefaults#colors()` for the default implementation that follows Material specifications.

| Parameters |
|---|---|
| `checkedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the checkmark when checked |
| `uncheckedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the checkmark when unchecked |
| `checkedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the color that will be used for the box when checked |
| `uncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the box when unchecked |
| `disabledCheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the box when disabled and checked |
| `disabledUncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the box when disabled and unchecked |
| `disabledIndeterminateBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the box and border in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.tv.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)` when disabled AND in an `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` state. |
| `checkedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the border when checked |
| `uncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the border when unchecked |
| `disabledBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the border when disabled and checked |
| `disabledUncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the border when disabled and unchecked |
| `disabledIndeterminateBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color that will be used for the border when disabled and in an `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` state. |

## Public functions

### copy

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tv#1.1.0)

```
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](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val checkedBorderColor: Color
```

color that will be used for the border when checked

### checkedBoxColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val checkedBoxColor: Color
```

the color that will be used for the box when checked

### checkedCheckmarkColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val checkedCheckmarkColor: Color
```

color that will be used for the checkmark when checked

### disabledBorderColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val disabledBorderColor: Color
```

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

### disabledCheckedBoxColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val disabledCheckedBoxColor: Color
```

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

### disabledIndeterminateBorderColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val disabledIndeterminateBorderColor: Color
```

color that will be used for the border when disabled and in an `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` state.

### disabledIndeterminateBoxColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val disabledIndeterminateBoxColor: Color
```

color that will be used for the box and border in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.tv.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)` when disabled AND in an `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` state.

### disabledUncheckedBorderColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val disabledUncheckedBorderColor: Color
```

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

### disabledUncheckedBoxColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val disabledUncheckedBoxColor: Color
```

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

### uncheckedBorderColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val uncheckedBorderColor: Color
```

color that will be used for the border when unchecked

### uncheckedBoxColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val uncheckedBoxColor: Color
```

color that will be used for the box when unchecked

### uncheckedCheckmarkColor

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val uncheckedCheckmarkColor: Color
```

color that will be used for the checkmark when unchecked