# ToggleButtonColors

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/ToggleButton.kt+class:androidx.compose.material3.ToggleButtonColors) Common/AllAndroid/JVM
- Cmn

  ```
  class ToggleButtonColors
  ```

*** ** * ** ***

Represents the container and content colors used in a toggle button in different states.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonDefaults#colors()` | for the default colors used in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ElevatedToggleButtonDefaults#colors()` | for the default colors used in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ElevatedToggleButton.composable#ElevatedToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/FilledTonalToggleButtonDefaults#colors()` | for the default colors used in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/FilledTonalToggleButton.composable#FilledTonalToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/OutlinedToggleButtonDefaults#colors()` | for the default colors used in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/OutlinedToggleButton.composable#OutlinedToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)`. |

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#ToggleButtonColors(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)( containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` create an instance with arbitrary colors. | Cmn |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#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)( containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, checkedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Returns a copy of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors`, optionally overriding some of the values. | Cmn |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#hashCode()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#checkedContainerColor()` the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when checked. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#checkedContentColor()` the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when checked. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#containerColor()` the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when enabled. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#contentColor()` the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when enabled. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#disabledContainerColor()` the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when not enabled. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors#disabledContentColor()` the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when not enabled. | Cmn |

## Public constructors

### ToggleButtonColors

Cmn

```
ToggleButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color,
    checkedContainerColor: Color,
    checkedContentColor: Color
)
```

create an instance with arbitrary colors.

| Parameters |
|---|---|
| `containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when enabled. |
| `contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when enabled. |
| `disabledContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when not enabled. |
| `disabledContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when not enabled. |
| `checkedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when checked. |
| `checkedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when checked. |

## Public functions

### copy

Cmn

```
fun copy(
    containerColor: Color = this.containerColor,
    contentColor: Color = this.contentColor,
    disabledContainerColor: Color = this.disabledContainerColor,
    disabledContentColor: Color = this.disabledContentColor,
    checkedContainerColor: Color = this.checkedContainerColor,
    checkedContentColor: Color = this.checkedContentColor
): ToggleButtonColors
```

Returns a copy of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButtonColors`, optionally overriding some of the values. This uses `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color#Unspecified()` to mean "use the value from the source".

### equals

Cmn

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

### hashCode

Cmn

```
open fun hashCode(): Int
```

## Public properties

### checkedContainerColor

Cmn

```
val checkedContainerColor: Color
```

the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when checked.

### checkedContentColor

Cmn

```
val checkedContentColor: Color
```

the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when checked.

### containerColor

Cmn

```
val containerColor: Color
```

the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when enabled.

### contentColor

Cmn

```
val contentColor: Color
```

the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when enabled.

### disabledContainerColor

Cmn

```
val disabledContainerColor: Color
```

the container color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when not enabled.

### disabledContentColor

Cmn

```
val disabledContentColor: Color
```

the content color of this `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleButton.composable#ToggleButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.ToggleButtonSize,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.ToggleButtonShapes,androidx.compose.material3.ToggleButtonColors,androidx.compose.material3.ToggleButtonElevation,androidx.compose.foundation.BorderStroke,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function1)` when not enabled.