IconToggleButtonColors

Class

Common
class IconToggleButtonColors(
    val containerColor: Color,
    val contentColor: Color,
    val disabledContainerColor: Color,
    val disabledContentColor: Color,
    val checkedContainerColor: Color,
    val checkedContentColor: Color,
)

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

  • See IconButtonDefaults.filledIconToggleButtonColors and IconButtonDefaults.filledTonalIconToggleButtonColors for the default colors used in a FilledIconButton.
  • See IconButtonDefaults.outlinedIconToggleButtonVibrantColors for the default colors used in a toggleable OutlinedIconButton.

Parameters

containerColorthe container color of this icon button when enabled.
contentColorthe content color of this icon button when enabled.
disabledContainerColorthe container color of this icon button when not enabled.
disabledContentColorthe content color of this icon button when not enabled.
checkedContainerColorthe container color of this icon button when checked.
checkedContentColorthe content color of this icon button when checked.

Functions

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,
    ) =
        IconToggleButtonColors(
            containerColor.takeOrElse { this.containerColor },
            contentColor.takeOrElse { this.contentColor },
            disabledContainerColor.takeOrElse { this.disabledContainerColor },
            disabledContentColor.takeOrElse { this.disabledContentColor },
            checkedContainerColor.takeOrElse { this.checkedContainerColor },
            checkedContentColor.takeOrElse { this.checkedContentColor },
        )

Returns a copy of this IconToggleButtonColors, optionally overriding some of the values. This uses the Color.Unspecified to mean “use the value from the source”