# CheckboxDefaults

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/Checkbox.kt+class:androidx.compose.material3.CheckboxDefaults) Common/AllAndroid/JVM
- Cmn

  ```
  object CheckboxDefaults
  ```

*** ** * ** ***

Defaults used in `https://developer.android.com/reference/kotlin/androidx/compose/material3/Checkbox.composable#Checkbox(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)` and `https://developer.android.com/reference/kotlin/androidx/compose/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)`.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxDefaults#colors()()` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxColors` that will animate between the provided colors according to the Material specification. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/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/compose/material3/CheckboxColors` that will animate between the provided colors according to the Material specification. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/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,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, disabledCheckmarkColor: 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 )` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxColors` that will animate between the provided colors according to the Material specification. | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/CheckboxDefaults#StrokeWidth()` The default stroke width for a `https://developer.android.com/reference/kotlin/androidx/compose/material3/Checkbox.composable#Checkbox(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)`. | Cmn |

## Public functions

### colors

Cmn

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

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

### colors

Cmn

```
@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/compose/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. By default, the inner box is transparent 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 border when disabled and unchecked. By default, the inner box is transparent when unchecked. |
| `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/compose/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.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 |

### colors

Cmn

```
@Composable
fun colors(
    checkedCheckmarkColor: Color = Color.Unspecified,
    uncheckedCheckmarkColor: Color = Color.Unspecified,
    disabledCheckmarkColor: Color = Color.Unspecified,
    checkedBoxColor: Color = Color.Unspecified,
    uncheckedBoxColor: Color = Color.Unspecified,
    disabledCheckedBoxColor: Color = Color.Unspecified,
    disabledUncheckedBoxColor: Color = Color.Unspecified,
    disabledIndeterminateBoxColor: Color = Color.Unspecified,
    checkedBorderColor: Color = Color.Unspecified,
    uncheckedBorderColor: Color = Color.Unspecified,
    disabledBorderColor: Color = Color.Unspecified,
    disabledUncheckedBorderColor: Color = Color.Unspecified,
    disabledIndeterminateBorderColor: Color = Color.Unspecified
): CheckboxColors
```

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

| Parameters |
|---|---|
| `checkedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the checkmark when checked |
| `uncheckedCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the checkmark when unchecked |
| `disabledCheckmarkColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the checkmark when disabled |
| `checkedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | the color that will be used for the box when checked |
| `uncheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the box when unchecked |
| `disabledCheckedBoxColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | 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.Unspecified` | 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.Unspecified` | color that will be used for the box and border in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/TriStateCheckbox.composable#TriStateCheckbox(androidx.compose.ui.state.ToggleableState,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.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.Unspecified` | color that will be used for the border when checked |
| `uncheckedBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | color that will be used for the border when unchecked |
| `disabledBorderColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | 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.Unspecified` | 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.Unspecified` | 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 properties

### StrokeWidth

Cmn

```
val StrokeWidth: Dp
```

The default stroke width for a `https://developer.android.com/reference/kotlin/androidx/compose/material3/Checkbox.composable#Checkbox(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.CheckboxColors,androidx.compose.foundation.interaction.MutableInteractionSource)`. This width will be used for the checkmark when the `Checkbox` is in a checked or indeterminate states, or for the outline when it's unchecked.