SwitchColors

Artifact: androidx.compose.material3:material3

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  class SwitchColors

---

Represents the colors used by a Switch in different states

Summary

Public constructors

SwitchColors(     checkedThumbColor: Color,     checkedTrackColor: Color,     checkedBorderColor: Color,     checkedIconColor: Color,     uncheckedThumbColor: Color,     uncheckedTrackColor: Color,     uncheckedBorderColor: Color,     uncheckedIconColor: Color,     disabledCheckedThumbColor: Color,     disabledCheckedTrackColor: Color,     disabledCheckedBorderColor: Color,     disabledCheckedIconColor: Color,     disabledUncheckedThumbColor: Color,     disabledUncheckedTrackColor: Color,     disabledUncheckedBorderColor: Color,     disabledUncheckedIconColor: Color ) create an instance with arbitrary colors.

Cmn

Public functions
SwitchColors	copy(     checkedThumbColor: Color,     checkedTrackColor: Color,     checkedBorderColor: Color,     checkedIconColor: Color,     uncheckedThumbColor: Color,     uncheckedTrackColor: Color,     uncheckedBorderColor: Color,     uncheckedIconColor: Color,     disabledCheckedThumbColor: Color,     disabledCheckedTrackColor: Color,     disabledCheckedBorderColor: Color,     disabledCheckedIconColor: Color,     disabledUncheckedThumbColor: Color,     disabledUncheckedTrackColor: Color,     disabledUncheckedBorderColor: Color,     disabledUncheckedIconColor: Color ) Returns a copy of this SwitchColors, optionally overriding some of the values.	Cmn
open operator Boolean	equals(other: Any?)	Cmn
open Int	hashCode()	Cmn

Public properties
Color	checkedBorderColor the color used for the border when enabled and checked	Cmn
Color	checkedIconColor the color used for the icon when enabled and checked	Cmn
Color	checkedThumbColor the color used for the thumb when enabled and checked	Cmn
Color	checkedTrackColor the color used for the track when enabled and checked	Cmn
Color	disabledCheckedBorderColor the color used for the border when disabled and checked	Cmn
Color	disabledCheckedIconColor the color used for the icon when disabled and checked	Cmn
Color	disabledCheckedThumbColor the color used for the thumb when disabled and checked	Cmn
Color	disabledCheckedTrackColor the color used for the track when disabled and checked	Cmn
Color	disabledUncheckedBorderColor the color used for the border when disabled and unchecked	Cmn
Color	disabledUncheckedIconColor the color used for the icon when disabled and unchecked	Cmn
Color	disabledUncheckedThumbColor the color used for the thumb when disabled and unchecked	Cmn
Color	disabledUncheckedTrackColor the color used for the track when disabled and unchecked	Cmn
Color	uncheckedBorderColor the color used for the border when enabled and unchecked	Cmn
Color	uncheckedIconColor the color used for the icon when enabled and unchecked	Cmn
Color	uncheckedThumbColor the color used for the thumb when enabled and unchecked	Cmn
Color	uncheckedTrackColor the color used for the track when enabled and unchecked	Cmn

Public constructors

SwitchColors

Cmn

SwitchColors(
    checkedThumbColor: Color,
    checkedTrackColor: Color,
    checkedBorderColor: Color,
    checkedIconColor: Color,
    uncheckedThumbColor: Color,
    uncheckedTrackColor: Color,
    uncheckedBorderColor: Color,
    uncheckedIconColor: Color,
    disabledCheckedThumbColor: Color,
    disabledCheckedTrackColor: Color,
    disabledCheckedBorderColor: Color,
    disabledCheckedIconColor: Color,
    disabledUncheckedThumbColor: Color,
    disabledUncheckedTrackColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledUncheckedIconColor: Color
)

create an instance with arbitrary colors. See SwitchDefaults.colors for the default implementation that follows Material specifications.

Parameters
checkedThumbColor: Color	the color used for the thumb when enabled and checked
checkedTrackColor: Color	the color used for the track when enabled and checked
checkedBorderColor: Color	the color used for the border when enabled and checked
checkedIconColor: Color	the color used for the icon when enabled and checked
uncheckedThumbColor: Color	the color used for the thumb when enabled and unchecked
uncheckedTrackColor: Color	the color used for the track when enabled and unchecked
uncheckedBorderColor: Color	the color used for the border when enabled and unchecked
uncheckedIconColor: Color	the color used for the icon when enabled and unchecked
disabledCheckedThumbColor: Color	the color used for the thumb when disabled and checked
disabledCheckedTrackColor: Color	the color used for the track when disabled and checked
disabledCheckedBorderColor: Color	the color used for the border when disabled and checked
disabledCheckedIconColor: Color	the color used for the icon when disabled and checked
disabledUncheckedThumbColor: Color	the color used for the thumb when disabled and unchecked
disabledUncheckedTrackColor: Color	the color used for the track when disabled and unchecked
disabledUncheckedBorderColor: Color	the color used for the border when disabled and unchecked
disabledUncheckedIconColor: Color	the color used for the icon when disabled and unchecked

Public functions

copy

Cmn

fun copy(
    checkedThumbColor: Color = this.checkedThumbColor,
    checkedTrackColor: Color = this.checkedTrackColor,
    checkedBorderColor: Color = this.checkedBorderColor,
    checkedIconColor: Color = this.checkedIconColor,
    uncheckedThumbColor: Color = this.uncheckedThumbColor,
    uncheckedTrackColor: Color = this.uncheckedTrackColor,
    uncheckedBorderColor: Color = this.uncheckedBorderColor,
    uncheckedIconColor: Color = this.uncheckedIconColor,
    disabledCheckedThumbColor: Color = this.disabledCheckedThumbColor,
    disabledCheckedTrackColor: Color = this.disabledCheckedTrackColor,
    disabledCheckedBorderColor: Color = this.disabledCheckedBorderColor,
    disabledCheckedIconColor: Color = this.disabledCheckedIconColor,
    disabledUncheckedThumbColor: Color = this.disabledUncheckedThumbColor,
    disabledUncheckedTrackColor: Color = this.disabledUncheckedTrackColor,
    disabledUncheckedBorderColor: Color = this.disabledUncheckedBorderColor,
    disabledUncheckedIconColor: Color = this.disabledUncheckedIconColor
): SwitchColors

Returns a copy of this SwitchColors, 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

checkedBorderColor

Cmn

Added in 1.2.0

val checkedBorderColor: Color

the color used for the border when enabled and checked

checkedIconColor

Cmn

Added in 1.2.0

val checkedIconColor: Color

the color used for the icon when enabled and checked

checkedThumbColor

Cmn

Added in 1.2.0

val checkedThumbColor: Color

the color used for the thumb when enabled and checked

checkedTrackColor

Cmn

Added in 1.2.0

val checkedTrackColor: Color

the color used for the track when enabled and checked

disabledCheckedBorderColor

Cmn

Added in 1.2.0

val disabledCheckedBorderColor: Color

the color used for the border when disabled and checked

disabledCheckedIconColor

Cmn

Added in 1.2.0

val disabledCheckedIconColor: Color

the color used for the icon when disabled and checked

disabledCheckedThumbColor

Cmn

Added in 1.2.0

val disabledCheckedThumbColor: Color

the color used for the thumb when disabled and checked

disabledCheckedTrackColor

Cmn

Added in 1.2.0

val disabledCheckedTrackColor: Color

the color used for the track when disabled and checked

disabledUncheckedBorderColor

Cmn

Added in 1.2.0

val disabledUncheckedBorderColor: Color

the color used for the border when disabled and unchecked

disabledUncheckedIconColor

Cmn

Added in 1.2.0

val disabledUncheckedIconColor: Color

the color used for the icon when disabled and unchecked

disabledUncheckedThumbColor

Cmn

Added in 1.2.0

val disabledUncheckedThumbColor: Color

the color used for the thumb when disabled and unchecked

disabledUncheckedTrackColor

Cmn

Added in 1.2.0

val disabledUncheckedTrackColor: Color

the color used for the track when disabled and unchecked

uncheckedBorderColor

Cmn

Added in 1.2.0

val uncheckedBorderColor: Color

the color used for the border when enabled and unchecked

uncheckedIconColor

Cmn

Added in 1.2.0

val uncheckedIconColor: Color

the color used for the icon when enabled and unchecked

uncheckedThumbColor

Cmn

Added in 1.2.0

val uncheckedThumbColor: Color

the color used for the thumb when enabled and unchecked

uncheckedTrackColor

Cmn

Added in 1.2.0

val uncheckedTrackColor: Color

the color used for the track when enabled and unchecked