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
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

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

Cmn
Color

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

Cmn
Color

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

Cmn
Color

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

Cmn
Color

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

Cmn
Color

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

Cmn
Color

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

Cmn

Public constructors

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

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

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

hashCode

open fun hashCode(): Int

iconColor

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

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

val disabledIconColorColor

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

disabledTextColor

val disabledTextColorColor

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

selectedIconColor

val selectedIconColorColor

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

selectedIndicatorColor

val selectedIndicatorColorColor

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

selectedTextColor

val selectedTextColorColor

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

unselectedIconColor

val unselectedIconColorColor

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

unselectedTextColor

val unselectedTextColorColor

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