NavigationItemColors

Artifact: androidx.compose.material3:material3

View Source

Added in 1.4.0-alpha03

Common/AllAndroid/JVM

• Cmn

  class NavigationItemColors

---

Represents the colors of the various elements of a navigation item.

Summary

Public constructors
NavigationItemColors(     selectedIconColor: Color,     selectedTextColor: Color,     selectedIndicatorColor: Color,     unselectedIconColor: Color,     unselectedTextColor: Color,     disabledIconColor: Color,     disabledTextColor: Color ) create an instance with arbitrary colors.	Cmn

Public functions
NavigationItemColors	copy(     selectedIconColor: Color,     selectedTextColor: Color,     selectedIndicatorColor: Color,     unselectedIconColor: Color,     unselectedTextColor: Color,     disabledIconColor: Color,     disabledTextColor: Color ) Returns a copy of this NavigationItemColors, optionally overriding some of the values.	Cmn
open operator Boolean	equals(other: Any?)	Cmn
open Int	hashCode()	Cmn
Color	iconColor(selected: Boolean, enabled: Boolean) Represents the icon color for this item, depending on whether it is selected.	Cmn
Color	textColor(selected: Boolean, enabled: Boolean) Represents the text color for this item, depending on whether it is selected.	Cmn

Public properties
Color	disabledIconColor the color to use for the icon when the item is disabled.	Cmn
Color	disabledTextColor the color to use for the text label when the item is disabled.	Cmn
Color	selectedIconColor the color to use for the icon when the item is selected.	Cmn
Color	selectedIndicatorColor the color to use for the indicator when the item is selected.	Cmn
Color	selectedTextColor the color to use for the text label when the item is selected.	Cmn
Color	unselectedIconColor the color to use for the icon when the item is unselected.	Cmn
Color	unselectedTextColor the color to use for the text label when the item is unselected.	Cmn

Public constructors

NavigationItemColors

Cmn

NavigationItemColors(
    selectedIconColor: Color,
    selectedTextColor: Color,
    selectedIndicatorColor: Color,
    unselectedIconColor: Color,
    unselectedTextColor: Color,
    disabledIconColor: Color,
    disabledTextColor: Color
)

create an instance with arbitrary colors.

Parameters
selectedIconColor: Color	the color to use for the icon when the item is selected.
selectedTextColor: Color	the color to use for the text label when the item is selected.
selectedIndicatorColor: Color	the color to use for the indicator when the item is selected.
unselectedIconColor: Color	the color to use for the icon when the item is unselected.
unselectedTextColor: Color	the color to use for the text label when the item is unselected.
disabledIconColor: Color	the color to use for the icon when the item is disabled.
disabledTextColor: Color	the color to use for the text label when the item is disabled.

Public functions

copy

Cmn

fun copy(
    selectedIconColor: Color = this.selectedIconColor,
    selectedTextColor: Color = this.selectedTextColor,
    selectedIndicatorColor: Color = this.selectedIndicatorColor,
    unselectedIconColor: Color = this.unselectedIconColor,
    unselectedTextColor: Color = this.unselectedTextColor,
    disabledIconColor: Color = this.disabledIconColor,
    disabledTextColor: Color = this.disabledTextColor
): NavigationItemColors

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

iconColor

Cmn

Added in 1.4.0-alpha03

fun iconColor(selected: Boolean, enabled: Boolean): Color

Represents the icon color for this item, depending on whether it is selected.

Parameters
selected: Boolean	whether the item is selected
enabled: Boolean	whether the item is enabled

textColor

Cmn

Added in 1.4.0-alpha03

fun textColor(selected: Boolean, enabled: Boolean): Color

Represents the text color for this item, depending on whether it is selected.

Parameters
selected: Boolean	whether the item is selected
enabled: Boolean	whether the item is enabled

Public properties

disabledIconColor

Cmn

Added in 1.4.0-alpha03

val disabledIconColor: Color

the color to use for the icon when the item is disabled.

disabledTextColor

Cmn

Added in 1.4.0-alpha03

val disabledTextColor: Color

the color to use for the text label when the item is disabled.

selectedIconColor

Cmn

Added in 1.4.0-alpha03

val selectedIconColor: Color

the color to use for the icon when the item is selected.

selectedIndicatorColor

Cmn

Added in 1.4.0-alpha03

val selectedIndicatorColor: Color

the color to use for the indicator when the item is selected.

selectedTextColor

Cmn

Added in 1.4.0-alpha03

val selectedTextColor: Color

the color to use for the text label when the item is selected.

unselectedIconColor

Cmn

Added in 1.4.0-alpha03

val unselectedIconColor: Color

the color to use for the icon when the item is unselected.

unselectedTextColor

Cmn

Added in 1.4.0-alpha03

val unselectedTextColor: Color

the color to use for the text label when the item is unselected.