WideNavigationRailColors


Represents the colors of the various elements of a wide navigation rail.

Summary

Public constructors

WideNavigationRailColors(
    containerColor: Color,
    contentColor: Color,
    modalContainerColor: Color,
    modalScrimColor: Color
)
Cmn

Public functions

WideNavigationRailColors
copy(
    containerColor: Color,
    contentColor: Color,
    modalContainerColor: Color,
    modalScrimColor: Color
)

Returns a copy of this NavigationRailColors, optionally overriding some of the values.

Cmn
open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn

Public properties

Color

the color used for the background of a non-modal wide navigation rail.

Cmn
Color

the preferred color for content inside a wide navigation rail.

Cmn
Color

the color used for the background of a modal wide navigation rail.

Cmn
Color

the color used for the scrim overlay for background content of a modal wide navigation rail

Cmn

Public constructors

WideNavigationRailColors

WideNavigationRailColors(
    containerColor: Color,
    contentColor: Color,
    modalContainerColor: Color,
    modalScrimColor: Color
)
Parameters
containerColor: Color

the color used for the background of a non-modal wide navigation rail. Use Color.Transparent to have no color

contentColor: Color

the preferred color for content inside a wide navigation rail. Defaults to either the matching content color for containerColor, or to the current LocalContentColor if containerColor is not a color from the theme

modalContainerColor: Color

the color used for the background of a modal wide navigation rail. Use Color.Transparent to have no color

modalScrimColor: Color

the color used for the scrim overlay for background content of a modal wide navigation rail

Public functions

copy

fun copy(
    containerColor: Color = this.containerColor,
    contentColor: Color = this.contentColor,
    modalContainerColor: Color = this.modalContainerColor,
    modalScrimColor: Color = this.modalScrimColor
): WideNavigationRailColors

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

Public properties

containerColor

val containerColorColor

the color used for the background of a non-modal wide navigation rail. Use Color.Transparent to have no color

contentColor

val contentColorColor

the preferred color for content inside a wide navigation rail. Defaults to either the matching content color for containerColor, or to the current LocalContentColor if containerColor is not a color from the theme

modalContainerColor

val modalContainerColorColor

the color used for the background of a modal wide navigation rail. Use Color.Transparent to have no color

modalScrimColor

val modalScrimColorColor

the color used for the scrim overlay for background content of a modal wide navigation rail