# CheckboxDefaults

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


```
object CheckboxDefaults
```

<br />

*** ** * ** ***

Defaults used in `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)` and `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)`.

## Summary

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxDefaults#colors()()` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` that will animate between the provided colors according to the Material specification. |
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxDefaults#colors(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)( checkedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, uncheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledCheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledUncheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledIndeterminateColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` that will animate between the provided colors according to the Material specification. |

## Public functions

### colors

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

```
@Composable
fun colors(): CheckboxColors
```

Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` that will animate between the provided colors according to the Material specification.

### colors

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

```
@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 `https://developer.android.com/reference/kotlin/androidx/tv/material3/CheckboxColors` that will animate between the provided colors according to the Material specification.

| Parameters |
|---|---|
| `checkedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | the color that will be used for the border and box when checked |
| `uncheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the border when unchecked |
| `checkmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the checkmark when checked |
| `disabledCheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the box and border when disabled and checked |
| `disabledUncheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the box and border when disabled and not checked |
| `disabledIndeterminateColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | 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. |