# CheckboxDefaults

Artifact: [androidx.glance:glance-appwidget](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/appwidget/CheckBox.kt+class:androidx.glance.appwidget.CheckboxDefaults) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)


```
object CheckboxDefaults
```

<br />

*** ** * ** ***

Contains the default values used by `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBox.composable#CheckBox(kotlin.Boolean,androidx.glance.action.Action,androidx.glance.GlanceModifier,kotlin.String,androidx.glance.text.TextStyle,androidx.glance.appwidget.CheckBoxColors,kotlin.Int)`.

## Summary

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors()()` Creates a default `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors`. |
| `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors(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)` |
| `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors(androidx.glance.unit.ColorProvider,androidx.glance.unit.ColorProvider)(checkedColor: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider, uncheckedColor: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider)` |

## Public functions

### colors

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

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

Creates a default `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors`.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` | default `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors`. |

### colors

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

```
@Composable
fun colors(checkedColor: Color, uncheckedColor: Color): CheckBoxColors
```

| Parameters |
|---|---|
| `checkedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` to use when the check box is checked. |
| `uncheckedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` to use when the check box is not checked. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` | `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` that uses `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)` or `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)` depending on the checked state of the CheckBox. |

### colors

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

```
@Composable
fun colors(checkedColor: ColorProvider, uncheckedColor: ColorProvider): CheckBoxColors
```

| Parameters |
|---|---|
| `checkedColor: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider` | the `https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider` to use when the check box is checked. |
| `uncheckedColor: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider` | the `https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider` to use when the check box is not checked. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` | `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckBoxColors` that uses `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors(androidx.glance.unit.ColorProvider,androidx.glance.unit.ColorProvider)` or `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/CheckboxDefaults#colors(androidx.glance.unit.ColorProvider,androidx.glance.unit.ColorProvider)` depending on the checked state of the CheckBox. |