ToggleButtonColors

Artifact: androidx.compose.material3:material3

View Source

Added in 1.4.0-alpha03

Common/AllAndroid/JVM

• Cmn

  class ToggleButtonColors

---

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

Summary

Public constructors
ToggleButtonColors(     containerColor: Color,     contentColor: Color,     disabledContainerColor: Color,     disabledContentColor: Color,     checkedContainerColor: Color,     checkedContentColor: Color ) create an instance with arbitrary colors.	Cmn

Public functions
ToggleButtonColors	copy(     containerColor: Color,     contentColor: Color,     disabledContainerColor: Color,     disabledContentColor: Color,     checkedContainerColor: Color,     checkedContentColor: Color ) Returns a copy of this ToggleButtonColors, optionally overriding some of the values.	Cmn
open operator Boolean	equals(other: Any?)	Cmn
open Int	hashCode()	Cmn

Public properties
Color	checkedContainerColor the container color of this ToggleButton when checked.	Cmn
Color	checkedContentColor the content color of this ToggleButton when checked.	Cmn
Color	containerColor the container color of this ToggleButton when enabled.	Cmn
Color	contentColor the content color of this ToggleButton when enabled.	Cmn
Color	disabledContainerColor the container color of this ToggleButton when not enabled.	Cmn
Color	disabledContentColor the content color of this ToggleButton 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.

• See ToggleButtonDefaults.toggleButtonColors for the default colors used in a ToggleButton.

• See ToggleButtonDefaults.elevatedToggleButtonColors for the default colors used in a ElevatedToggleButton.

• See ToggleButtonDefaults.tonalToggleButtonColors for the default colors used in a TonalToggleButton.

• See ToggleButtonDefaults.outlinedToggleButtonColors for the default colors used in a OutlinedToggleButton.

Parameters
containerColor: Color	the container color of this ToggleButton when enabled.
contentColor: Color	the content color of this ToggleButton when enabled.
disabledContainerColor: Color	the container color of this ToggleButton when not enabled.
disabledContentColor: Color	the content color of this ToggleButton when not enabled.
checkedContainerColor: Color	the container color of this ToggleButton when checked.
checkedContentColor: Color	the content color of this ToggleButton 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 ToggleButtonColors, optionally overriding some of the values. This uses the 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

Added in 1.4.0-alpha03

val checkedContainerColor: Color

the container color of this ToggleButton when checked.

checkedContentColor

Cmn

Added in 1.4.0-alpha03

val checkedContentColor: Color

the content color of this ToggleButton when checked.

containerColor

Cmn

Added in 1.4.0-alpha03

val containerColor: Color

the container color of this ToggleButton when enabled.

contentColor

Cmn

Added in 1.4.0-alpha03

val contentColor: Color

the content color of this ToggleButton when enabled.

disabledContainerColor

Cmn

Added in 1.4.0-alpha03

val disabledContainerColor: Color

the container color of this ToggleButton when not enabled.

disabledContentColor

Cmn

Added in 1.4.0-alpha03

val disabledContentColor: Color

the content color of this ToggleButton when not enabled.